Skip to content

SystemAccessDeviceGetAllRequest

Bases: OCIRequest

Requests the list of all access devices in the entire system. Prior to release 14, this functionality was provided with the SystemAccessDeviceGetListRequest14. If reseller administrator sends the request, searchCriteriaResellerId is ignored. All the device profiles in the administrator's reseller meeting the search criteria are returned.

The response is either SystemAccessDeviceGetAllResponse or ErrorResponse.

The following data elements are only used in AS data mode:
  searchCriteriaResellerId

Attributes:

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_group_id (Optional[List[SearchCriteriaGroupId]]):

search_criteria_exact_device_type (Optional[SearchCriteriaExactDeviceType]):

search_criteria_exact_device_service_provider (Optional[SearchCriteriaExactDeviceServiceProvider]):

search_criteria_service_provider_id (Optional[List[SearchCriteriaServiceProviderId]]):

search_criteria_reseller_id (Optional[List[SearchCriteriaResellerId]]):
Source code in src/mercury_ocip_fast/commands/commands.py
@dataclass(kw_only=True)
class SystemAccessDeviceGetAllRequest(OCIRequest):
    """Requests the list of all access devices in the entire system.
        Prior to release 14, this functionality was provided with the SystemAccessDeviceGetListRequest14.
        If reseller administrator sends the request, searchCriteriaResellerId is ignored. All the device
        profiles in the administrator's reseller meeting the search criteria are returned.

        The response is either SystemAccessDeviceGetAllResponse or ErrorResponse.

        The following data elements are only used in AS data mode:
          searchCriteriaResellerId

    Attributes:

        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_group_id (Optional[List[SearchCriteriaGroupId]]):

        search_criteria_exact_device_type (Optional[SearchCriteriaExactDeviceType]):

        search_criteria_exact_device_service_provider (Optional[SearchCriteriaExactDeviceServiceProvider]):

        search_criteria_service_provider_id (Optional[List[SearchCriteriaServiceProviderId]]):

        search_criteria_reseller_id (Optional[List[SearchCriteriaResellerId]]):

    """

    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_group_id: Optional[List[SearchCriteriaGroupId]] = field(
        default=None, metadata={"alias": "searchCriteriaGroupId"}
    )

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

    search_criteria_exact_device_service_provider: Optional[
        SearchCriteriaExactDeviceServiceProvider
    ] = field(
        default=None, metadata={"alias": "searchCriteriaExactDeviceServiceProvider"}
    )

    search_criteria_service_provider_id: Optional[
        List[SearchCriteriaServiceProviderId]
    ] = field(default=None, metadata={"alias": "searchCriteriaServiceProviderId"})

    search_criteria_reseller_id: Optional[List[SearchCriteriaResellerId]] = field(
        default=None, metadata={"alias": "searchCriteriaResellerId"}
    )

Responses

Bases: OCIDataResponse

Response to SystemAccessDeviceGetAllRequest. Contains a table of devices configured in the entire system. The column headings are: "Service Provider Id", "Is Enterprise", "Group Id", "Device Name", "Device Type", "Net Address", "MAC Address", "Status", "Reseller Id", "Access Device External Id".

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

Attributes:

access_device_table (OCITable):
Source code in src/mercury_ocip_fast/commands/commands.py
@dataclass(kw_only=True)
class SystemAccessDeviceGetAllResponse(OCIDataResponse):
    """Response to SystemAccessDeviceGetAllRequest.
        Contains a table of devices configured in the entire system.
        The column headings are: \"Service Provider Id\", \"Is Enterprise\", \"Group Id\",
        \"Device Name\", \"Device Type\", \"Net Address\", \"MAC Address\", \"Status\", \"Reseller Id\",
        \"Access Device External Id\".

        The following columns are only returned in AS data mode:
          \"Reseller Id\"
          \"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 SystemAccessDeviceGetAllRequest

client = Client()

command = SystemAccessDeviceGetAllRequest(
    response_size_limit=...,
    search_criteria_device_name=...,
    search_criteria_device_mac_address=...,
    search_criteria_device_net_address=...,
    search_criteria_group_id=...,
    search_criteria_exact_device_type=...,
    search_criteria_exact_device_service_provider=...,
    search_criteria_service_provider_id=...,
    search_criteria_reseller_id=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip_fast.client import Client

client = Client()

response = client.raw_command("SystemAccessDeviceGetAllRequest",
    response_size_limit=...,
    search_criteria_device_name=...,
    search_criteria_device_mac_address=...,
    search_criteria_device_net_address=...,
    search_criteria_group_id=...,
    search_criteria_exact_device_type=...,
    search_criteria_exact_device_service_provider=...,
    search_criteria_service_provider_id=...,
    search_criteria_reseller_id=...,
)

print(response)