Skip to content

SystemAccessDeviceGetRequest24V3

Bases: OCIRequest

Requests the configuration of a specified system access device.

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

The response is either SystemAccessDeviceGetResponse24V3 or ErrorResponse.

Attributes:

device_name (Optional[str]):

device_external_id (Optional[str]):
Source code in src/mercury_ocip_fast/commands/commands.py
@dataclass(kw_only=True)
class SystemAccessDeviceGetRequest24V3(OCIRequest):
    """Requests the configuration of a specified system access device.

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

        The response is either SystemAccessDeviceGetResponse24V3 or ErrorResponse.

    Attributes:

        device_name (Optional[str]):

        device_external_id (Optional[str]):

    """

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

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

Responses

Bases: OCIDataResponse

Response to SystemAccessDeviceGetRequest24V3

The following elements are only used in AS data mode:
   version
   deviceName
   deviceExternalId

The following elements are only used in AS data mode and not returned in XS data mode:
   isWebexTeamsDevice
   defaultPathHeader
   deviceCode
   deviceIPEI
   deviceIndex
   useDeviceCode
   authBearerSubject

Attributes:

device_type (str):

protocol (str):

net_address (Optional[str]):

port (Optional[int]):

outbound_proxy_server_net_address (Optional[str]):

stun_server_net_address (Optional[str]):

mac_address (Optional[str]):

serial_number (Optional[str]):

description (Optional[str]):

number_of_ports (UnboundedPositiveInt):

number_of_assigned_ports (int):

status (str):

physical_location (Optional[str]):

transport_protocol (Optional[str]):

use_custom_user_name_password (Optional[bool]):

user_name (Optional[str]):

version (Optional[str]):

is_webex_teams_device (Optional[bool]):

default_path_header (Optional[str]):

device_name (str):

device_external_id (Optional[str]):

device_code (Optional[str]):

device_ipei (Optional[str]):

device_index (Optional[int]):

use_device_code (Optional[bool]):

auth_bearer_subject (Optional[str]):
Source code in src/mercury_ocip_fast/commands/commands.py
@dataclass(kw_only=True)
class SystemAccessDeviceGetResponse24V3(OCIDataResponse):
    """Response to SystemAccessDeviceGetRequest24V3

        The following elements are only used in AS data mode:
           version
           deviceName
           deviceExternalId

        The following elements are only used in AS data mode and not returned in XS data mode:
           isWebexTeamsDevice
           defaultPathHeader
           deviceCode
           deviceIPEI
           deviceIndex
           useDeviceCode
           authBearerSubject

    Attributes:

        device_type (str):

        protocol (str):

        net_address (Optional[str]):

        port (Optional[int]):

        outbound_proxy_server_net_address (Optional[str]):

        stun_server_net_address (Optional[str]):

        mac_address (Optional[str]):

        serial_number (Optional[str]):

        description (Optional[str]):

        number_of_ports (UnboundedPositiveInt):

        number_of_assigned_ports (int):

        status (str):

        physical_location (Optional[str]):

        transport_protocol (Optional[str]):

        use_custom_user_name_password (Optional[bool]):

        user_name (Optional[str]):

        version (Optional[str]):

        is_webex_teams_device (Optional[bool]):

        default_path_header (Optional[str]):

        device_name (str):

        device_external_id (Optional[str]):

        device_code (Optional[str]):

        device_ipei (Optional[str]):

        device_index (Optional[int]):

        use_device_code (Optional[bool]):

        auth_bearer_subject (Optional[str]):

    """

    device_type: str = field(metadata={"alias": "deviceType"})

    protocol: str = field(metadata={"alias": "protocol"})

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

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

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

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

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

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

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

    number_of_ports: UnboundedPositiveInt = field(metadata={"alias": "numberOfPorts"})

    number_of_assigned_ports: int = field(metadata={"alias": "numberOfAssignedPorts"})

    status: str = field(metadata={"alias": "status"})

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

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

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

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

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

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

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

    device_name: str = field(metadata={"alias": "deviceName"})

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

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

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

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

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

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

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 SystemAccessDeviceGetRequest24V3

client = Client()

command = SystemAccessDeviceGetRequest24V3(
    device_name=...,
    device_external_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("SystemAccessDeviceGetRequest24V3",
    device_name=...,
    device_external_id=...,
)

print(response)