Jump to

• Request
• Response

Modify the CliManager object.

put

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

modify the CliManager object.

Request

Path Parameters

• CliManagerId(required):
  CliManagerId to modify the associated CliManager.

Header Parameters

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

Supported Media Types

• application/x-www-form-urlencoded

Request Body - application/x-www-form-urlencoded ()

Root Schema : schema

Type: object

Show Source

• cliManager: object CliManager
  The CliManager provides control over the command line interface.

{
    "properties":{
        "cliManager":{
            "$ref":"#/components/schemas/CliManager",
            "type":"object"
        }
    }
}

Nested 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

Security

• basicAuth: http
  Type: http

Back to Top

Response

Supported Media Types

• application/json

200 Response

Request completed successfully.

Body ()

Root Schema : Job

Type: object

A Job represents the unit of work required to perform a particular action or set of actions. The Job Id value represents the time when the Job was created in milliseconds since epoch. This will be a unique value in relation to other Job objects.

Show Source

• abortedUser: string
  Maximum Length: 256
• associatedObjId: string
  Maximum Length: 128
• associatedObjType: string
  Maximum Length: 256
• endTime: timestamp
  Read-only and this operation is unsupported. @param endTime Time in milliseconds.
• jobName(required): string
  Maximum Length: 256
• progressMessage: string
  Maximum Length: 1024

  Read-only and this operation is unsupported. @param progressMessage.
• result: AssociatedObj
• runState: string
  Allowed Values: [ "ACTIVE", "SUCCEEDED", "FAILED", "ABORTED" ]
• startTime: timestamp
  Read-only and this operation is unsupported. @param startTime The startTime to set.
• transcript: string
  Maximum Length: 1000
• username: string
  Maximum Length: 64
• workItemIds: array workItemIds
• workRequestId: string
  Maximum Length: 256

{
    "properties":{
        "result":{
            "description":"",
            "type":"AssociatedObj"
        },
        "associatedObjType":{
            "description":"",
            "maxLength":256,
            "type":"string"
        },
        "associatedObjId":{
            "description":"",
            "maxLength":128,
            "type":"string"
        },
        "workRequestId":{
            "description":"",
            "maxLength":256,
            "type":"string"
        },
        "abortedUser":{
            "description":"",
            "maxLength":256,
            "type":"string"
        },
        "endTime":{
            "description":"Read-only and this operation is unsupported. @param endTime Time in milliseconds.",
            "type":"timestamp"
        },
        "jobName":{
            "description":"",
            "maxLength":256,
            "type":"string"
        },
        "progressMessage":{
            "description":"Read-only and this operation is unsupported. @param progressMessage.",
            "maxLength":1024,
            "type":"string"
        },
        "runState":{
            "description":"",
            "enum":[
                "ACTIVE",
                "SUCCEEDED",
                "FAILED",
                "ABORTED"
            ],
            "type":"string"
        },
        "startTime":{
            "description":"Read-only and this operation is unsupported. @param startTime The startTime to set.",
            "type":"timestamp"
        },
        "transcript":{
            "description":"",
            "maxLength":1000,
            "type":"string"
        },
        "username":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "workItemIds":{
            "description":"",
            "type":"array"
        }
    },
    "required":[
        "jobName"
    ],
    "type":"object",
    "description":"A Job represents the unit of work required to perform a particular action or set of actions. The Job Id value represents the time when the Job was created in milliseconds since epoch. This will be a unique value in relation to other Job objects."
}

Nested Schema : workItemIds

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