Skip to content

ServiceProviderAccessDeviceModifyRequest22

Bases: OCIRequest

Request to modify a specified service provider access device. The response is either SuccessResponse or ErrorResponse.

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

Attributes:

service_provider_id (Optional[str]):

device_name (Optional[str]):

device_external_id (Optional[str]):

protocol (Optional[str]):

net_address (Optional[Nillable[str]]):

port (Optional[Nillable[int]]):

outbound_proxy_server_net_address (Optional[Nillable[str]]):

stun_server_net_address (Optional[Nillable[str]]):

mac_address (Optional[Nillable[str]]):

serial_number (Optional[Nillable[str]]):

description (Optional[Nillable[str]]):

physical_location (Optional[Nillable[str]]):

transport_protocol (Optional[str]):

use_custom_user_name_password (Optional[bool]):

access_device_credentials (Optional[Nillable[DeviceManagementUserNamePassword16]]):

device_ipei (Optional[Nillable[str]]):

use_device_code (Optional[bool]):

device_code (Optional[Nillable[str]]):
Source code in src/mercury_ocip_fast/commands/commands.py
@dataclass(kw_only=True)
class ServiceProviderAccessDeviceModifyRequest22(OCIRequest):
    """Request to modify a specified service provider access device.
        The response is either SuccessResponse or ErrorResponse.

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

    Attributes:

        service_provider_id (Optional[str]):

        device_name (Optional[str]):

        device_external_id (Optional[str]):

        protocol (Optional[str]):

        net_address (Optional[Nillable[str]]):

        port (Optional[Nillable[int]]):

        outbound_proxy_server_net_address (Optional[Nillable[str]]):

        stun_server_net_address (Optional[Nillable[str]]):

        mac_address (Optional[Nillable[str]]):

        serial_number (Optional[Nillable[str]]):

        description (Optional[Nillable[str]]):

        physical_location (Optional[Nillable[str]]):

        transport_protocol (Optional[str]):

        use_custom_user_name_password (Optional[bool]):

        access_device_credentials (Optional[Nillable[DeviceManagementUserNamePassword16]]):

        device_ipei (Optional[Nillable[str]]):

        use_device_code (Optional[bool]):

        device_code (Optional[Nillable[str]]):

    """

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

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

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

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

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

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

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

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

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

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

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

    physical_location: Optional[Nillable[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"}
    )

    access_device_credentials: Optional[
        Nillable[DeviceManagementUserNamePassword16]
    ] = field(default=None, metadata={"alias": "accessDeviceCredentials"})

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

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

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

    def __post_init__(self):
        nillable_fields = [
            "net_address",
            "port",
            "outbound_proxy_server_net_address",
            "stun_server_net_address",
            "mac_address",
            "serial_number",
            "description",
            "physical_location",
            "access_device_credentials",
            "device_ipei",
            "device_code",
        ]
        for field_name in nillable_fields:
            value = getattr(self, field_name)
            if value == "" or value == "None":
                object.__setattr__(self, field_name, OCINil)

Responses

Bases: OCIResponse

Source code in src/mercury_ocip_fast/commands/base_command.py
class SuccessResponse(OCIResponse):
    pass

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 ServiceProviderAccessDeviceModifyRequest22

client = Client()

command = ServiceProviderAccessDeviceModifyRequest22(
    service_provider_id=...,
    device_name=...,
    device_external_id=...,
    protocol=...,
    net_address=...,
    port=...,
    outbound_proxy_server_net_address=...,
    stun_server_net_address=...,
    mac_address=...,
    serial_number=...,
    description=...,
    physical_location=...,
    transport_protocol=...,
    use_custom_user_name_password=...,
    access_device_credentials=...,
    device_ipei=...,
    use_device_code=...,
    device_code=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip_fast.client import Client

client = Client()

response = client.raw_command("ServiceProviderAccessDeviceModifyRequest22",
    service_provider_id=...,
    device_name=...,
    device_external_id=...,
    protocol=...,
    net_address=...,
    port=...,
    outbound_proxy_server_net_address=...,
    stun_server_net_address=...,
    mac_address=...,
    serial_number=...,
    description=...,
    physical_location=...,
    transport_protocol=...,
    use_custom_user_name_password=...,
    access_device_credentials=...,
    device_ipei=...,
    use_device_code=...,
    device_code=...,
)

print(response)