Skip to content

SystemDeviceManagementTagGetListRequest

Bases: OCIRequest

Request to get the list of custom configuration tags managed by the Device Management System. The response is either SystemDeviceManagementTagGetListResponse or ErrorResponse.

Attributes:

system_default_tag_set (Optional[bool]):

tag_set_name (Optional[str]):
Source code in src/mercury_ocip/commands/commands.py
@dataclass(kw_only=True)
class SystemDeviceManagementTagGetListRequest(OCIRequest):
    """Request to get the list of custom configuration tags managed by the Device Management System.
        The response is either SystemDeviceManagementTagGetListResponse or ErrorResponse.

    Attributes:

        system_default_tag_set (Optional[bool]):

        tag_set_name (Optional[str]):

    """

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

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

Responses

Bases: OCIDataResponse

Response to SystemDeviceManagementTagGetListRequest. Contains a table of custom configuration tags managed by the Device Management System. In AS data mode, the column headings are: "Tag Name", "Tag Value", "Is Overridable". In XS data mode, the column headings are: "Tag Name", "Tag Value", "Is Overridable", "Is Encrypted".

Attributes:

tags_table (OCITable):
Source code in src/mercury_ocip/commands/commands.py
@dataclass(kw_only=True)
class SystemDeviceManagementTagGetListResponse(OCIDataResponse):
    """Response to SystemDeviceManagementTagGetListRequest.
        Contains a table of custom configuration tags managed by the Device Management System.
        In AS data mode, the column headings are: \"Tag Name\", \"Tag Value\", \"Is Overridable\".
        In XS data mode, the column headings are: \"Tag Name\", \"Tag Value\", \"Is Overridable\", \"Is Encrypted\".

    Attributes:

        tags_table (OCITable):

    """

    tags_table: OCITable = field(metadata={"alias": "tagsTable"})

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 SystemDeviceManagementTagGetListRequest

client = Client()

command = SystemDeviceManagementTagGetListRequest(
    system_default_tag_set=...,
    tag_set_name=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip.client import Client

client = Client()

response = client.raw_command("SystemDeviceManagementTagGetListRequest",
    system_default_tag_set=...,
    tag_set_name=...,
)

print(response)