GroupAccessDeviceGetListRequest

Bases: OCIRequest

Requests the list of access devices in a group.

The following elements are only used in AS data mode and ignored in XS data mode:
  groupExternalId

The response is either GroupAccessDeviceGetListResponse or ErrorResponse.

Attributes:

service_provider_id (Optional[str]):

group_id (Optional[str]):

group_external_id (Optional[str]):

response_size_limit (Optional[int]):

search_criteria_device_name (Optional[List[SearchCriteriaDeviceName]]):

search_criteria_device_mac_address (Optional[List[SearchCriteriaDeviceMACAddress]]):

search_criteria_device_net_address (Optional[List[SearchCriteriaDeviceNetAddress]]):

search_criteria_exact_device_type (Optional[SearchCriteriaExactDeviceType]):

search_criteria_access_device_version (Optional[List[SearchCriteriaAccessDeviceVersion]]):

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

@dataclass(kw_only=True)
class GroupAccessDeviceGetListRequest(OCIRequest):
    """Requests the list of access devices in a group.

        The following elements are only used in AS data mode and ignored in XS data mode:
          groupExternalId

        The response is either GroupAccessDeviceGetListResponse or ErrorResponse.

    Attributes:

        service_provider_id (Optional[str]):

        group_id (Optional[str]):

        group_external_id (Optional[str]):

        response_size_limit (Optional[int]):

        search_criteria_device_name (Optional[List[SearchCriteriaDeviceName]]):

        search_criteria_device_mac_address (Optional[List[SearchCriteriaDeviceMACAddress]]):

        search_criteria_device_net_address (Optional[List[SearchCriteriaDeviceNetAddress]]):

        search_criteria_exact_device_type (Optional[SearchCriteriaExactDeviceType]):

        search_criteria_access_device_version (Optional[List[SearchCriteriaAccessDeviceVersion]]):

    """

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

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

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

    response_size_limit: Optional[int] = field(
        default=None, metadata={"alias": "responseSizeLimit"}
    )

    search_criteria_device_name: Optional[List[SearchCriteriaDeviceName]] = field(
        default=None, metadata={"alias": "searchCriteriaDeviceName"}
    )

    search_criteria_device_mac_address: Optional[
        List[SearchCriteriaDeviceMACAddress]
    ] = field(default=None, metadata={"alias": "searchCriteriaDeviceMACAddress"})

    search_criteria_device_net_address: Optional[
        List[SearchCriteriaDeviceNetAddress]
    ] = field(default=None, metadata={"alias": "searchCriteriaDeviceNetAddress"})

    search_criteria_exact_device_type: Optional[SearchCriteriaExactDeviceType] = field(
        default=None, metadata={"alias": "searchCriteriaExactDeviceType"}
    )

    search_criteria_access_device_version: Optional[
        List[SearchCriteriaAccessDeviceVersion]
    ] = field(default=None, metadata={"alias": "searchCriteriaAccessDeviceVersion"})

Responses

Bases: OCIDataResponse

Response to GroupAccessDeviceGetListRequest. Contains a table of devices configured in the group. The column headings are: "Device Name", "Device Type", "Available Ports", "Net Address", "MAC Address", "Status", "Version", and "Access Device External Id".

The following columns are only populated in AS data mode:
  "Access Device External Id"

Attributes:

access_device_table (OCITable):

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

@dataclass(kw_only=True)
class GroupAccessDeviceGetListResponse(OCIDataResponse):
    """Response to GroupAccessDeviceGetListRequest.
        Contains a table of devices configured in the group.
        The column headings are: \"Device Name\", \"Device Type\", \"Available Ports\", \"Net Address\", \"MAC Address\", \"Status\", \"Version\",
        and \"Access Device External Id\".

        The following columns are only populated in AS data mode:
          \"Access Device External Id\"

    Attributes:

        access_device_table (OCITable):

    """

    access_device_table: OCITable = field(metadata={"alias": "accessDeviceTable"})

Bases: OCIResponse

Source code in src/mercury_ocip_fast/commands/base_command.py

class ErrorResponse(OCIResponse):
    errorCode: Optional[int] = None
    summary: str
    summaryEnglish: str
    detail: Optional[str] = None

Example Usage

from mercury_ocip_fast.client import Client
from mercury_ocip_fast.commands import GroupAccessDeviceGetListRequest

client = Client()

command = GroupAccessDeviceGetListRequest(
    service_provider_id=...,
    group_id=...,
    group_external_id=...,
    response_size_limit=...,
    search_criteria_device_name=...,
    search_criteria_device_mac_address=...,
    search_criteria_device_net_address=...,
    search_criteria_exact_device_type=...,
    search_criteria_access_device_version=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip_fast.client import Client

client = Client()

response = client.raw_command("GroupAccessDeviceGetListRequest",
    service_provider_id=...,
    group_id=...,
    group_external_id=...,
    response_size_limit=...,
    search_criteria_device_name=...,
    search_criteria_device_mac_address=...,
    search_criteria_device_net_address=...,
    search_criteria_exact_device_type=...,
    search_criteria_access_device_version=...,
)

print(response)