Device CLI

Description

defaultDescription

Security

Secured (HTTP Basic Authentication)

DEFAULT

DELETE ``/api/v2/hocapi/v1/provider/{provider-name}/cli_snippet/_schedule/{schedule-id}``

Parameters

Name

Located in

Required

Type

Format

Properties

Description

schedule-id

path

Yes

string

Generated path parameter. Example value =’schedule-id’

provider-name

path

Yes

string

Generated path parameter. Example value =’root’

Request

Headers

provider: Generated header parameter. Example value ='root'

Responses

200

Type: Schedule_delete_response

Example:

{
    "message": "somestring"
}

Security

Security Schema

Scopes

Secured

DELETE ``/api/v2/hocapi/v1/provider/{provider-name}/cli_snippet/{snippet-id}``

Parameters

Name

Located in

Required

Type

Format

Properties

Description

snippet-id

path

Yes

string

Generated path parameter. Example value =’snippet-id’

provider-name

path

Yes

string

Generated path parameter. Example value =’root’

Request

Headers

provider: Generated header parameter. Example value ='root'
user: Generated header parameter. Example value ='super-admin'

Responses

200

Type: Snippet_delete_response

Example:

{
    "message": "somestring"
}

Security

Security Schema

Scopes

Secured

GET ``/api/v2/hwcapi/v1/workflow/{workflow-id}``

Parameters

Name

Located in

Required

Type

Format

Properties

Description

workflow-id

path

Yes

string

Generated path parameter. Example value =’workflow-id’

Request

Headers

provider: Generated header parameter. Example value ='root'

Responses

200

Security

Security Schema

Scopes

Secured

POST ``/api/v2/hocapi/v1/provider/{provider-name}/cli_snippet/``

Parameters

Name

Located in

Required

Type

Format

Properties

Description

provider-name

path

Yes

string

Generated path parameter. Example value =’root’

Request

Headers

provider: Generated header parameter. Example value ='root'
user: Generated header parameter. Example value ='super-admin'

Body

Name

Required

Type

Format

Properties

Description

content

No

string

name

No

string

{
    "content": "somestring",
    "name": "somestring"
}

Responses

200

Type: Snippet_response

Example:

{
    "content": "somestring",
    "created_at": "somestring",
    "created_by": "somestring",
    "id": "somestring",
    "last_modified_at": "somestring",
    "last_modified_by": "somestring",
    "name": "somestring",
    "provider": "somestring"
}

Security

Security Schema

Scopes

Secured

POST ``/api/v2/hocapi/v1/provider/{provider-name}/cli_snippet/_run``

Parameters

Name

Located in

Required

Type

Format

Properties

Description

provider-name

path

Yes

string

Generated path parameter. Example value =’root’

Request

Headers

provider: Generated header parameter. Example value ='root'
user: Generated header parameter. Example value ='super-admin'

Body

Name

Required

Type

Format

Properties

Description

client

No

string

commands_source

No

array of string

devices

No

array of cli_run_device_param

{
    "client": "somestring",
    "commands_source": [
        "somestring",
        "somestring"
    ],
    "devices": [
        {
            "name": "somestring",
            "partition": "somestring"
        },
        {
            "name": "somestring",
            "partition": "somestring"
        }
    ]
}

Responses

200

Type: cli_run_response

Example:

{
    "details": {
        "qa_auto_10.64.42.52-device-2020-07-06-03:38:41": {
            "output": {
                "execution-time": 1,
                "result": {
                    "message": "somestring",
                    "response": [
                        "somestring",
                        "somestring"
                    ]
                }
            },
            "status": "somestring"
        }
    },
    "providerId": "somestring"
}

Security

Security Schema

Scopes

Secured

POST ``/api/v2/hocapi/v1/provider/{provider-name}/cli_snippet/_schedule``

Parameters

Name

Located in

Required

Type

Format

Properties

Description

provider-name

path

Yes

string

Generated path parameter. Example value =’root’

Request

Headers

provider: Generated header parameter. Example value ='root'

Body

Name

Required

Type

Format

Properties

Description

input_parameters

No

Input_parameters

name

No

string

schedule

No

Schedule

snippet_id

No

string

type

No

string

{
    "input_parameters": {
        "commands_source": "somestring",
        "devices": [
            {
                "name": "somestring",
                "partition": "somestring"
            },
            {
                "name": "somestring",
                "partition": "somestring"
            }
        ],
        "scheduler": {
            "frequency": "somestring",
            "startsOn": "somestring"
        }
    },
    "name": "somestring",
    "schedule": {
        "is-repeating": true,
        "minute": 1
    },
    "snippet_id": "somestring",
    "type": "somestring"
}

Responses

200

Type: Schedule_response

Example:

{
    "created_at": "somestring",
    "created_by": {},
    "id": "somestring",
    "input_parameters": "somestring",
    "last_modified_at": "somestring",
    "last_modified_by": {},
    "name": "somestring",
    "provider": "somestring",
    "snippet_id": "somestring",
    "type": "somestring"
}

Security

Security Schema

Scopes

Secured

Data Structures

CLI Troubleshoot Payload Model Structure

Name

Required

Type

Format

Properties

Description

client

No

string

commands_source

No

array of string

devices

No

array of cli_run_device_param

Devices Model Structure

Name

Required

Type

Format

Properties

Description

name

No

string

partition

No

string

Input Parameters Model Structure

Name

Required

Type

Format

Properties

Description

commands_source

No

string

devices

No

array of Devices

scheduler

No

Scheduler

Output Model Structure

Name

Required

Type

Format

Properties

Description

execution-time

No

integer

int32

result

No

Result

Result Model Structure

Name

Required

Type

Format

Properties

Description

message

No

string

response

No

array of string

Schedule Model Structure

Name

Required

Type

Format

Properties

Description

is-repeating

No

boolean

minute

No

integer

int32

Schedule Delete Response Model Structure

Name

Required

Type

Format

Properties

Description

message

No

string

Schedule Payload Model Structure

Name

Required

Type

Format

Properties

Description

input_parameters

No

Input_parameters

name

No

string

schedule

No

Schedule

snippet_id

No

string

type

No

string

Schedule Response Model Structure

Name

Required

Type

Format

Properties

Description

created_at

No

string

created_by

No

created_by

id

No

string

input_parameters

No

string

last_modified_at

No

string

last_modified_by

No

created_by

name

No

string

provider

No

string

snippet_id

No

string

type

No

string

Created_by schema:

Scheduler Model Structure

Name

Required

Type

Format

Properties

Description

frequency

No

string

startsOn

No

string

Snippet Delete Response Model Structure

Name

Required

Type

Format

Properties

Description

message

No

string

Snippet Payload Model Structure

Name

Required

Type

Format

Properties

Description

content

No

string

name

No

string

Snippet Response Model Structure

Name

Required

Type

Format

Properties

Description

content

No

string

created_at

No

string

created_by

No

string

id

No

string

last_modified_at

No

string

last_modified_by

No

string

name

No

string

provider

No

string

CLI Run Device Details Model Structure

Name

Required

Type

Format

Properties

Description

output

No

Output

status

No

string

CLI Run Device Param Model Structure

Name

Required

Type

Format

Properties

Description

name

No

string

partition

No

string

CLI Run Response Model Structure

Name

Required

Type

Format

Properties

Description

details

No

cli_run_response_Details

providerId

No

string

CLI Run Response Details Model Structure

Name

Required

Type

Format

Properties

Description

qa_auto_10.64.42.52-device-2020-07-06-03:38:41

No

cli_run_device_details