Lab Services — Systems

8 min

get_systems

sync(client: AuthenticatedClient | Client, include_unconnected_systems: bool | Unset = False, apiversion: str | Unset = UNSET) -> list[SystemResult] | None

Parameter	Type	Default
client	AuthenticatedClient \| Client	required
include_unconnected_systems	bool \| Unset	False
apiversion	str \| Unset	UNSET

include_unconnected_systems — Default: False.

Returns: list[SystemResult] | None

Raises:

Exception	Condition
UnexpectedStatus	If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
TimeoutException	If the request takes longer than Client.timeout.

get_systems_name

sync(name: str, client: AuthenticatedClient | Client, apiversion: str | Unset = UNSET) -> ProblemDetails | SystemResult | None

Parameter	Type	Default
name	str	required
client	AuthenticatedClient \| Client	required
apiversion	str \| Unset	UNSET

Returns: ProblemDetails | SystemResult | None

Raises:

Exception	Condition
UnexpectedStatus	If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
TimeoutException	If the request takes longer than Client.timeout.

get_systems_version_info

sync(client: AuthenticatedClient | Client, apiversion: str | Unset = UNSET) -> list[SystemVersionInfoResult] | None

Parameter	Type	Default
client	AuthenticatedClient \| Client	required
apiversion	str \| Unset	UNSET

Returns: list[SystemVersionInfoResult] | None

Raises:

Exception	Condition
UnexpectedStatus	If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
TimeoutException	If the request takes longer than Client.timeout.

put_systems_name

sync(name: str, client: AuthenticatedClient | Client, body: SystemActionRequest | Unset = UNSET, apiversion: str | Unset = UNSET) -> Any | ProblemDetails | None

Parameter	Type	Default
name	str	required
client	AuthenticatedClient \| Client	required
body	SystemActionRequest \| Unset	UNSET
apiversion	str \| Unset	UNSET

Returns: Any | ProblemDetails | None

Raises:

Exception	Condition
UnexpectedStatus	If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
TimeoutException	If the request takes longer than Client.timeout.