SystemFileRepositoryDeviceAddRequest20

Bases: OCIRequest

Add a new file repository. The response is either SuccessResponse or ErrorResponse.

Attributes:

name (str):

root_directory (Optional[str]):

port (Optional[int]):

protocol_web_dav (Optional[FileRepositoryProtocolWebDAV20]):

protocol_ftp (Optional[FileRepositoryProtocolFTP16]):

protocol_sftp (Optional[FileRepositoryProtocolFTP16]):

protocol_ftps (Optional[FileRepositoryProtocolFTP16]):

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

@dataclass(kw_only=True)
class SystemFileRepositoryDeviceAddRequest20(OCIRequest):
    """Add a new file repository.
        The response is either SuccessResponse or ErrorResponse.

    Attributes:

        name (str):

        root_directory (Optional[str]):

        port (Optional[int]):

        protocol_web_dav (Optional[FileRepositoryProtocolWebDAV20]):

        protocol_ftp (Optional[FileRepositoryProtocolFTP16]):

        protocol_sftp (Optional[FileRepositoryProtocolFTP16]):

        protocol_ftps (Optional[FileRepositoryProtocolFTP16]):

    """

    name: str = field(metadata={"alias": "name"})

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

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

    protocol_web_dav: Optional[FileRepositoryProtocolWebDAV20] = field(
        default=None, metadata={"alias": "protocolWebDAV"}
    )

    protocol_ftp: Optional[FileRepositoryProtocolFTP16] = field(
        default=None, metadata={"alias": "protocolFTP"}
    )

    protocol_sftp: Optional[FileRepositoryProtocolFTP16] = field(
        default=None, metadata={"alias": "protocolSFTP"}
    )

    protocol_ftps: Optional[FileRepositoryProtocolFTP16] = field(
        default=None, metadata={"alias": "protocolFTPS"}
    )

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 SystemFileRepositoryDeviceAddRequest20

client = Client()

command = SystemFileRepositoryDeviceAddRequest20(
    name=...,
    root_directory=...,
    port=...,
    protocol_web_dav=...,
    protocol_ftp=...,
    protocol_sftp=...,
    protocol_ftps=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip_fast.client import Client

client = Client()

response = client.raw_command("SystemFileRepositoryDeviceAddRequest20",
    name=...,
    root_directory=...,
    port=...,
    protocol_web_dav=...,
    protocol_ftp=...,
    protocol_sftp=...,
    protocol_ftps=...,
)

print(response)