Skip to content

SystemAccessDeviceLinkDeviceListRequest

Bases: OCIRequest

Request to link one or more leaf devices to a system level tree device. A tree device is a device associated with a device type that has the option supportLinks set to "Support Links from Devices". Many leaf devices can be linked to it. A leaf device is a device associated with a device type that has the option supportLinks set to "Support Link to Device" or "Support Link to Device and User". It can be linked to only one tree device. The response is either a SuccessResponse or an ErrorResponse.

Attributes:

device_name (str):

leaf_device_key (List[AccessDeviceKey]):
Source code in src/mercury_ocip_fast/commands/commands.py
@dataclass(kw_only=True)
class SystemAccessDeviceLinkDeviceListRequest(OCIRequest):
    """Request to link one or more leaf devices to a system level tree device.
        A tree device is a device associated with a device type that has the option
        supportLinks set to \"Support Links from Devices\". Many leaf devices can be linked to it.
        A leaf device is a device associated with a device type that has the option
        supportLinks set to \"Support Link to Device\" or \"Support Link to Device and User\".  It can
        be linked to only one tree device.
        The response is either a SuccessResponse or an ErrorResponse.

    Attributes:

        device_name (str):

        leaf_device_key (List[AccessDeviceKey]):

    """

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

    leaf_device_key: List[AccessDeviceKey] = field(metadata={"alias": "leafDeviceKey"})

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 SystemAccessDeviceLinkDeviceListRequest

client = Client()

command = SystemAccessDeviceLinkDeviceListRequest(
    device_name=...,
    leaf_device_key=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip_fast.client import Client

client = Client()

response = client.raw_command("SystemAccessDeviceLinkDeviceListRequest",
    device_name=...,
    leaf_device_key=...,
)

print(response)