Jump to

• Request
• Response

Get CliManager object.

get

https://{host}:{port}/{basePath}/CliManager/

get CliManager object.

Request

Header Parameters

• Auth-Token(required): string
  Auth-Token received from a successful login response.
• opc-request-id: string
  Unique identifier for the request

There's no request body for this operation.

Security

• basicAuth: http
  Type: http

Back to Top

Response

Supported Media Types

• application/json

200 Response

Request completed successfully.

Body ()

Root Schema : CliManager

Type: object

The CliManager provides control over the command line interface.

Show Source

• commandTimeout(required): integer
  Sets the command timeout value in minutes. @param commandTimeout Value (in minutes) to set the commandTimeout.
• faultIds: array faultIds
• inactivityTimeout(required): integer
  Sets the current inactivity timeout value in minutes. @param inactivityTimeout Value (in minutes) to set the inactivity Timeout to.
• runState: string
  Allowed Values: [ "RUNNING", "STOPPED", "UNKNOWN" ]

  The Manager's run state is read-only and this operation is unsupported. @param runState to set manager to.
• sshPort(required): integer
  Sets the SSH port value. The {@link CliManager} must be restarted before any changes to the SSH port will take effect. @param sshPort The sshPort to use.

{
    "properties":{
        "sshPort":{
            "description":"Sets the SSH port value. The {@link CliManager} must be restarted before any changes to the SSH port will take effect. @param sshPort The sshPort to use.",
            "type":"integer"
        },
        "inactivityTimeout":{
            "description":"Sets the current inactivity timeout value in minutes. @param inactivityTimeout Value (in minutes) to set the inactivity Timeout to.",
            "type":"integer"
        },
        "commandTimeout":{
            "description":"Sets the command timeout value in minutes. @param commandTimeout Value (in minutes) to set the commandTimeout.",
            "type":"integer"
        },
        "runState":{
            "description":"The Manager's run state is read-only and this operation is unsupported. @param runState to set manager to.",
            "enum":[
                "RUNNING",
                "STOPPED",
                "UNKNOWN"
            ],
            "type":"string"
        },
        "faultIds":{
            "description":"",
            "type":"array"
        }
    },
    "required":[
        "sshPort",
        "inactivityTimeout",
        "commandTimeout"
    ],
    "type":"object",
    "description":"The CliManager provides control over the command line interface."
}

Nested Schema : faultIds

Type: array

400 Response

Bad request

Body ()

Root Schema : Error

Type: object

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error string.

{
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "type":"object"
}

401 Response

Unauthorized

Body ()

Root Schema : Error

Type: object

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error string.

{
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "type":"object"
}

404 Response

Not Found

Body ()

Root Schema : Error

Type: object

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error string.

{
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "type":"object"
}

500 Response

Internal Server Error

Body ()

Root Schema : Error

Type: object

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error string.

{
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "type":"object"
}

Default Response

An error has occurred

Body ()

Root Schema : Error

Type: object

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error string.

{
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "type":"object"
}

Back to Top