SystemRoutingGetRouteDeviceListRequest

Bases: OCIRequest

Request to get a list of devices for a route. The response is either a SystemRoutingGetRouteDeviceListResponse or an ErrorResponse.

Attributes:

route_name (str):

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

@dataclass(kw_only=True)
class SystemRoutingGetRouteDeviceListRequest(OCIRequest):
    """Request to get a list of devices for a route.
        The response is either a SystemRoutingGetRouteDeviceListResponse or an ErrorResponse.

    Attributes:

        route_name (str):

    """

    route_name: str = field(metadata={"alias": "routeName"})

Responses

Bases: OCIDataResponse

Response to SystemRoutingGetRouteDeviceListRequest. The column headings are "Net Address", "Port", "Transport" and "Description".

Attributes:

route_device_table (OCITable):

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

@dataclass(kw_only=True)
class SystemRoutingGetRouteDeviceListResponse(OCIDataResponse):
    """Response to SystemRoutingGetRouteDeviceListRequest. The column headings are \"Net Address\",
        \"Port\", \"Transport\" and \"Description\".

    Attributes:

        route_device_table (OCITable):

    """

    route_device_table: OCITable = field(metadata={"alias": "routeDeviceTable"})

Bases: OCIResponse

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

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

Example Usage

from mercury_ocip.client import Client
from mercury_ocip.commands import SystemRoutingGetRouteDeviceListRequest

client = Client()

command = SystemRoutingGetRouteDeviceListRequest(
    route_name=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip.client import Client

client = Client()

response = client.raw_command("SystemRoutingGetRouteDeviceListRequest",
    route_name=...,
)

print(response)