GroupAccessDeviceAvailablePortGetListRequest

Bases: OCIRequest

Request to get the list of available ports in a device. The response is either GroupAccessDeviceAvailablePortGetListResponse or ErrorResponse.

Attributes:

service_provider_id (str):

group_id (str):

access_device (AccessDevice):

Source code in src/mercury_ocip/commands/commands.py

@dataclass(kw_only=True)
class GroupAccessDeviceAvailablePortGetListRequest(OCIRequest):
    """Request to get the list of available ports in a device.
        The response is either GroupAccessDeviceAvailablePortGetListResponse or ErrorResponse.

    Attributes:

        service_provider_id (str):

        group_id (str):

        access_device (AccessDevice):

    """

    service_provider_id: str = field(metadata={"alias": "serviceProviderId"})

    group_id: str = field(metadata={"alias": "groupId"})

    access_device: AccessDevice = field(metadata={"alias": "accessDevice"})

Responses

Bases: OCIDataResponse

Response to GroupAccessDeviceAvailablePortGetListRequest. Contains a list of available ports in a device using static mode. The list is empty in case the device is using dynamic mode.

Attributes:

port_number (Optional[List[int]]):

Source code in src/mercury_ocip/commands/commands.py

@dataclass(kw_only=True)
class GroupAccessDeviceAvailablePortGetListResponse(OCIDataResponse):
    """Response to GroupAccessDeviceAvailablePortGetListRequest.
        Contains a list of available ports in a device using static mode. The list is empty in case the device is using dynamic mode.

    Attributes:

        port_number (Optional[List[int]]):

    """

    port_number: Optional[List[int]] = field(
        default=None, metadata={"alias": "portNumber"}
    )

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 GroupAccessDeviceAvailablePortGetListRequest

client = Client()

command = GroupAccessDeviceAvailablePortGetListRequest(
    service_provider_id=...,
    group_id=...,
    access_device=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip.client import Client

client = Client()

response = client.raw_command("GroupAccessDeviceAvailablePortGetListRequest",
    service_provider_id=...,
    group_id=...,
    access_device=...,
)

print(response)