Skip to content

DeviceManagementFileAuthLocationGetRequest22V4

Bases: OCIRequest

Get the address and credentials of the File Repository hosting the requested access device file. Also get the file name and path on the File Repository. The response is either DeviceManagementFileAuthLocationGetResponse22V4 or ErrorResponse. The following elements are only used in AS data mode and will fail in XS data mode: deviceToken The following elements are only used in XS data mode and will be ignored in AS data mode: fileNameLookup fileNameOnDisk

Attributes:

device_access_protocol (str):

device_access_method (str):

device_access_uri (str):

access_device_user_name (Optional[str]):

access_device_user_password (Optional[str]):

device_token (Optional[str]):

signed_password (Optional[str]):

mac_address (Optional[str]):

realm_name (Optional[str]):

digest_ha1_complement (Optional[str]):

digest_response (Optional[str]):

file_name_lookup (Optional[bool]):

file_name_on_disk (Optional[str]):
Source code in src/mercury_ocip_fast/commands/commands.py
@dataclass(kw_only=True)
class DeviceManagementFileAuthLocationGetRequest22V4(OCIRequest):
    """Get the address and credentials of the File Repository hosting the requested access device file.
        Also get the file name and path on the File Repository.
        The response is either DeviceManagementFileAuthLocationGetResponse22V4 or ErrorResponse.
        The following elements are only used in AS data mode and will fail in XS data mode:
          deviceToken
        The following elements are only used in XS data mode and will be ignored in AS data mode:
          fileNameLookup
          fileNameOnDisk

    Attributes:

        device_access_protocol (str):

        device_access_method (str):

        device_access_uri (str):

        access_device_user_name (Optional[str]):

        access_device_user_password (Optional[str]):

        device_token (Optional[str]):

        signed_password (Optional[str]):

        mac_address (Optional[str]):

        realm_name (Optional[str]):

        digest_ha1_complement (Optional[str]):

        digest_response (Optional[str]):

        file_name_lookup (Optional[bool]):

        file_name_on_disk (Optional[str]):

    """

    device_access_protocol: str = field(metadata={"alias": "deviceAccessProtocol"})

    device_access_method: str = field(metadata={"alias": "deviceAccessMethod"})

    device_access_uri: str = field(metadata={"alias": "deviceAccessURI"})

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

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

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

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

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

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

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

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

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

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

Responses

Bases: OCIDataResponse

This is a response to DeviceManagementFileAuthLocationGetRequest22V4. Return the address and credentials of the File Repository hosting the requested access device file. Also return the file name and path on the File Repository. Also returns the status of the file authentication.

Attributes:

status (Optional[str]):

file_repository_user_name (Optional[str]):

file_repository_password (Optional[str]):

file_repos_access_token (Optional[str]):

net_address (str):

remote_file_format (str):

port_number (Optional[int]):

root_directory (Optional[str]):

cpe_file_directory (Optional[str]):

secure (Optional[bool]):

mac_in_non_request_uri (Optional[bool]):

mac_in_cert (Optional[bool]):

mac_format_in_non_request_uri (Optional[str]):

use_http_digest_authentication (Optional[bool]):

mac_based_file_authentication (Optional[bool]):

user_name_password_file_authentication (Optional[bool]):

completion_notification (Optional[bool]):

file_category (Optional[str]):

enable_caching (Optional[bool]):

notify_file_upload (Optional[bool]):
Source code in src/mercury_ocip_fast/commands/commands.py
@dataclass(kw_only=True)
class DeviceManagementFileAuthLocationGetResponse22V4(OCIDataResponse):
    """This is a response to DeviceManagementFileAuthLocationGetRequest22V4.
        Return the address and credentials of the File Repository hosting the requested access device file.
        Also return the file name and path on the File Repository.
        Also returns the status of the file authentication.

    Attributes:

        status (Optional[str]):

        file_repository_user_name (Optional[str]):

        file_repository_password (Optional[str]):

        file_repos_access_token (Optional[str]):

        net_address (str):

        remote_file_format (str):

        port_number (Optional[int]):

        root_directory (Optional[str]):

        cpe_file_directory (Optional[str]):

        secure (Optional[bool]):

        mac_in_non_request_uri (Optional[bool]):

        mac_in_cert (Optional[bool]):

        mac_format_in_non_request_uri (Optional[str]):

        use_http_digest_authentication (Optional[bool]):

        mac_based_file_authentication (Optional[bool]):

        user_name_password_file_authentication (Optional[bool]):

        completion_notification (Optional[bool]):

        file_category (Optional[str]):

        enable_caching (Optional[bool]):

        notify_file_upload (Optional[bool]):

    """

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

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

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

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

    net_address: str = field(metadata={"alias": "netAddress"})

    remote_file_format: str = field(metadata={"alias": "remoteFileFormat"})

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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 DeviceManagementFileAuthLocationGetRequest22V4

client = Client()

command = DeviceManagementFileAuthLocationGetRequest22V4(
    device_access_protocol=...,
    device_access_method=...,
    device_access_uri=...,
    access_device_user_name=...,
    access_device_user_password=...,
    device_token=...,
    signed_password=...,
    mac_address=...,
    realm_name=...,
    digest_ha1_complement=...,
    digest_response=...,
    file_name_lookup=...,
    file_name_on_disk=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip_fast.client import Client

client = Client()

response = client.raw_command("DeviceManagementFileAuthLocationGetRequest22V4",
    device_access_protocol=...,
    device_access_method=...,
    device_access_uri=...,
    access_device_user_name=...,
    access_device_user_password=...,
    device_token=...,
    signed_password=...,
    mac_address=...,
    realm_name=...,
    digest_ha1_complement=...,
    digest_response=...,
    file_name_lookup=...,
    file_name_on_disk=...,
)

print(response)