Skip to content

SystemDeviceManagementGetAccessDeviceCountForDeviceTypeRequest

Bases: OCIRequest

Request the number of access device of a particular device type or all device types if deviceType is not specified. If countOnlyResetSupportedDevice is true, count only access devices if the device type supports reset. By default unmanaged device types are not allowed and devices are counted only if their device type supports Device Management. An error is returned if deviceType is specified but does not support device management. When allowUnmanagedDeviceType is true, unmanaged device type will be counted and a successful response is returned. The response is either SystemDeviceManagementGetAccessDeviceCountForDeviceTypeResponse or ErrorResponse.

Attributes:

device_type (Optional[str]):

count_only_reset_supported_device (Optional[bool]):

allow_unmanaged_device_type (Optional[bool]):
Source code in src/mercury_ocip/commands/commands.py
@dataclass(kw_only=True)
class SystemDeviceManagementGetAccessDeviceCountForDeviceTypeRequest(OCIRequest):
    """Request the number of access device of a particular device type or all
        device types if deviceType is not specified.
        If countOnlyResetSupportedDevice is true, count only access devices if the device type supports reset.
        By default unmanaged device types are not allowed and devices are counted only if their device type supports Device Management.
        An error is returned if deviceType is specified but does not support device management.
        When allowUnmanagedDeviceType is true, unmanaged device type will be counted and a successful response is returned.
        The response is either SystemDeviceManagementGetAccessDeviceCountForDeviceTypeResponse or ErrorResponse.

    Attributes:

        device_type (Optional[str]):

        count_only_reset_supported_device (Optional[bool]):

        allow_unmanaged_device_type (Optional[bool]):

    """

    device_type: Optional[str] = field(default=None, metadata={"alias": "deviceType"})

    count_only_reset_supported_device: Optional[bool] = field(
        default=None, metadata={"alias": "countOnlyResetSupportedDevice"}
    )

    allow_unmanaged_device_type: Optional[bool] = field(
        default=None, metadata={"alias": "allowUnmanagedDeviceType"}
    )

Responses

Bases: OCIDataResponse

Response to SystemDeviceManagementGetAccessDeviceCountForDeviceTypeRequest.

Attributes:

access_device_count (int):
Source code in src/mercury_ocip/commands/commands.py
@dataclass(kw_only=True)
class SystemDeviceManagementGetAccessDeviceCountForDeviceTypeResponse(OCIDataResponse):
    """Response to SystemDeviceManagementGetAccessDeviceCountForDeviceTypeRequest.

    Attributes:

        access_device_count (int):

    """

    access_device_count: int = field(metadata={"alias": "accessDeviceCount"})

Bases: OCIResponse

Source code in src/mercury_ocip/commands/base_command.py
class ErrorResponse(OCIResponse):
    errorCode: Optional[int] = None
    summary: str
    summaryEnglish: str
    detail: Optional[str] = None

Example Usage

from mercury_ocip.client import Client
from mercury_ocip.commands import SystemDeviceManagementGetAccessDeviceCountForDeviceTypeRequest

client = Client()

command = SystemDeviceManagementGetAccessDeviceCountForDeviceTypeRequest(
    device_type=...,
    count_only_reset_supported_device=...,
    allow_unmanaged_device_type=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip.client import Client

client = Client()

response = client.raw_command("SystemDeviceManagementGetAccessDeviceCountForDeviceTypeRequest",
    device_type=...,
    count_only_reset_supported_device=...,
    allow_unmanaged_device_type=...,
)

print(response)