Device Management

Description

defaultDescription

DEFAULT

DELETE ``/api/v2/hpcapi/v3/provider/{provider-name}/cluster/{cluster-name}``

Parameters

Name

Located in

Required

Type

Format

Properties

Description

provider-name

path

Yes

string

Provider name. Example value =’root’

cluster-name

path

Yes

string

Cluster name. Example value =’test-cluster’

Request

Headers

authorization: Generated header parameter. Example value ='Basic c3VwZXItYWRtaW46cGFzc3dvcmQ='
provider: Generated header parameter. Example value ='root'

Responses

200

GET ``/api/v2/datastore/object-workflow-map``

Parameters

Name

Located in

Required

Type

Format

Properties

Description

wf_id

query

No

string

Request

Headers

authorization: Generated header parameter. Example value ='Basic c3VwZXItYWRtaW46cGFzc3dvcmQ='
provider: Generated header parameter. Example value ='root'

Responses

200

Type: ObjectWorkflowResponse

Example:

{
    "resultSet": [
        {
            "d46c162a-9fd4-11ea-b855-be926aaf4d07": {
                "obj_id": "somestring",
                "obj_type": "somestring",
                "provider_id": "somestring",
                "status": "somestring",
                "status_message": "somestring",
                "tenant_id": "somestring",
                "workflow_created_on": 1,
                "workflow_id": "somestring",
                "workflow_type": "somestring"
            }
        },
        {
            "d46c162a-9fd4-11ea-b855-be926aaf4d07": {
                "obj_id": "somestring",
                "obj_type": "somestring",
                "provider_id": "somestring",
                "status": "somestring",
                "status_message": "somestring",
                "tenant_id": "somestring",
                "workflow_created_on": 1,
                "workflow_id": "somestring",
                "workflow_type": "somestring"
            }
        }
    ],
    "resultSetCount": 1,
    "totalRecordsCount": 1
}

GET ``/api/v2/hpcapi/v3/provider/{provider-name}/cluster/{cluster-name}``

Parameters

Name

Located in

Required

Type

Format

Properties

Description

provider-name

path

Yes

string

Provider name. Example value =’root’

cluster-name

path

Yes

string

Cluster name. Example value =’test-cluster’

Request

Headers

authorization: Generated header parameter. Example value ='Basic c3VwZXItYWRtaW46cGFzc3dvcmQ='
provider: Generated header parameter. Example value ='root'

Responses

200

Type: ClusterResponse

Example:

{
    "cluster": {
        "a10-url": "somestring",
        "cluster-uuid": "somestring",
        "display-name": "somestring",
        "manual-pt-mapping": 1,
        "name": "somestring",
        "provision-state": "somestring",
        "type": "somestring",
        "uuid": "somestring"
    }
}

GET ``/api/v2/hpcapi/v3/provider/{provider-name}/device/{device-name}``

Parameters

Name

Located in

Required

Type

Format

Properties

Description

provider-name

path

Yes

string

Provider name. Example value =’root’

device-name

path

Yes

string

Cluster name. Example value =’test-device’

Request

Headers

authorization: Generated header parameter. Example value ='Basic c3VwZXItYWRtaW46cGFzc3dvcmQ='
provider: Generated header parameter. Example value ='root'

Responses

200

Type: DeviceResponse

Example:

{
    "device": {
        "a10-url": "somestring",
        "cluster": "somestring",
        "device-oper-status": {
            "a10-url": "somestring",
            "clock-drift": "somestring",
            "network-connectivity": "somestring",
            "uuid": "somestring"
        },
        "device-uuid": "somestring",
        "ha-primary": 1,
        "host": "somestring",
        "license-state": "somestring",
        "licenseinfo-list": [
            {
                "a10-url": "somestring",
                "device-bandwidth": "somestring",
                "lic-key": "somestring",
                "license-state": "somestring",
                "license-type": "somestring",
                "uuid": "somestring"
            },
            {
                "a10-url": "somestring",
                "device-bandwidth": "somestring",
                "lic-key": "somestring",
                "license-state": "somestring",
                "license-type": "somestring",
                "uuid": "somestring"
            }
        ],
        "location": "somestring",
        "management-interface": 1,
        "metrics-export-interval": 1,
        "mgmt-port-disable": 1,
        "mgmt-port-secure": 1,
        "mgmt-secure-port-disable": 1,
        "name": "somestring",
        "region": "somestring",
        "registration-state": "somestring",
        "uuid": "somestring",
        "zone": "somestring"
    }
}

GET ``/api/v2/hpcapi/v3/provider/root/cluster``

Parameters

Name

Located in

Required

Type

Format

Properties

Description

detail

query

No

string

Request

Headers

authorization: Generated header parameter. Example value ='Basic c3VwZXItYWRtaW46cGFzc3dvcmQ='
provider: Generated header parameter. Example value ='root'

Responses

200

Type: array of ClusterResponse_Cluster

Example:

[
    {
        "a10-url": "somestring",
        "cluster-uuid": "somestring",
        "display-name": "somestring",
        "manual-pt-mapping": 1,
        "name": "somestring",
        "provision-state": "somestring",
        "type": "somestring",
        "uuid": "somestring"
    },
    {
        "a10-url": "somestring",
        "cluster-uuid": "somestring",
        "display-name": "somestring",
        "manual-pt-mapping": 1,
        "name": "somestring",
        "provision-state": "somestring",
        "type": "somestring",
        "uuid": "somestring"
    }
]

GET ``/api/v2/hpcapi/v3/provider/root/device``

Parameters

Name

Located in

Required

Type

Format

Properties

Description

detail

query

No

string

Request

Headers

authorization: Generated header parameter. Example value ='Basic c3VwZXItYWRtaW46cGFzc3dvcmQ='
provider: Generated header parameter. Example value ='root'

Responses

200

Type: array of DeviceResponse_Device

Example:

[
    {
        "a10-url": "somestring",
        "cluster": "somestring",
        "device-oper-status": {
            "a10-url": "somestring",
            "clock-drift": "somestring",
            "network-connectivity": "somestring",
            "uuid": "somestring"
        },
        "device-uuid": "somestring",
        "ha-primary": 1,
        "host": "somestring",
        "license-state": "somestring",
        "licenseinfo-list": [
            {
                "a10-url": "somestring",
                "device-bandwidth": "somestring",
                "lic-key": "somestring",
                "license-state": "somestring",
                "license-type": "somestring",
                "uuid": "somestring"
            },
            {
                "a10-url": "somestring",
                "device-bandwidth": "somestring",
                "lic-key": "somestring",
                "license-state": "somestring",
                "license-type": "somestring",
                "uuid": "somestring"
            }
        ],
        "location": "somestring",
        "management-interface": 1,
        "metrics-export-interval": 1,
        "mgmt-port-disable": 1,
        "mgmt-port-secure": 1,
        "mgmt-secure-port-disable": 1,
        "name": "somestring",
        "region": "somestring",
        "registration-state": "somestring",
        "uuid": "somestring",
        "zone": "somestring"
    },
    {
        "a10-url": "somestring",
        "cluster": "somestring",
        "device-oper-status": {
            "a10-url": "somestring",
            "clock-drift": "somestring",
            "network-connectivity": "somestring",
            "uuid": "somestring"
        },
        "device-uuid": "somestring",
        "ha-primary": 1,
        "host": "somestring",
        "license-state": "somestring",
        "licenseinfo-list": [
            {
                "a10-url": "somestring",
                "device-bandwidth": "somestring",
                "lic-key": "somestring",
                "license-state": "somestring",
                "license-type": "somestring",
                "uuid": "somestring"
            },
            {
                "a10-url": "somestring",
                "device-bandwidth": "somestring",
                "lic-key": "somestring",
                "license-state": "somestring",
                "license-type": "somestring",
                "uuid": "somestring"
            }
        ],
        "location": "somestring",
        "management-interface": 1,
        "metrics-export-interval": 1,
        "mgmt-port-disable": 1,
        "mgmt-port-secure": 1,
        "mgmt-secure-port-disable": 1,
        "name": "somestring",
        "region": "somestring",
        "registration-state": "somestring",
        "uuid": "somestring",
        "zone": "somestring"
    }
]

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

Parameters

Name

Located in

Required

Type

Format

Properties

Description

provider-name

path

Yes

string

Provider name. Example value =’root’

device-name

path

Yes

string

Device name. Example value =’test-device’

Request

Headers

authorization: Generated header parameter. Example value ='Basic c3VwZXItYWRtaW46cGFzc3dvcmQ='
provider: Generated header parameter. Example value ='root'

Body

Name

Required

Type

Format

Properties

Description

device

No

RegisterDeviceRequest

{
    "device": {
        "password": "somestring",
        "username": "somestring"
    }
}

Responses

200

Type: CreateWorkflowResponse

Example:

{
    "workflow": {
        "uuid": "somestring"
    }
}

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

Parameters

Name

Located in

Required

Type

Format

Properties

Description

provider-name

path

Yes

string

Provider name. Example value =’root’

device-name

path

Yes

string

Device name. Example value =’test-device’

Request

Headers

authorization: Generated header parameter. Example value ='Basic c3VwZXItYWRtaW46cGFzc3dvcmQ='
provider: Generated header parameter. Example value ='root'

Body

Name

Required

Type

Format

Properties

Description

force-delete

No

boolean

{
    "force-delete": true
}

Responses

200

Type: CreateWorkflowResponse

Example:

{
    "workflow": {
        "uuid": "somestring"
    }
}

POST ``/api/v2/hpcapi/v3/provider/{provider-name}/cluster``

Parameters

Name

Located in

Required

Type

Format

Properties

Description

provider-name

path

Yes

string

Provider name. Example value =’root’

Request

Headers

authorization: Generated header parameter. Example value ='Basic c3VwZXItYWRtaW46cGFzc3dvcmQ='
provider: Generated header parameter. Example value ='root'

Body

Name

Required

Type

Format

Properties

Description

cluster

No

CreateClusterrRequest

{
    "cluster": {
        "description": "somestring",
        "display-name": "somestring",
        "name": "somestring",
        "type": "somestring"
    }
}

Responses

200

Type: CreateClusterrResponse

Example:

{
    "cluster": {
        "a10-url": "somestring",
        "description": "somestring",
        "display-name": "somestring",
        "manual-pt-mapping": 1,
        "name": "somestring",
        "provision-state": "somestring",
        "type": "somestring",
        "uuid": "somestring"
    }
}

POST ``/api/v2/hpcapi/v3/provider/{provider-name}/device``

Parameters

Name

Located in

Required

Type

Format

Properties

Description

provider-name

path

Yes

string

Provider name. Example value =’root’

Request

Headers

authorization: Generated header parameter. Example value ='Basic c3VwZXItYWRtaW46cGFzc3dvcmQ='
provider: Generated header parameter. Example value ='root'

Body

Name

Required

Type

Format

Properties

Description

device-list

No

array of CreateDeviceRequest

{
    "device-list": [
        {
            "cluster": "somestring",
            "host": "somestring",
            "location": "somestring",
            "management-interface": true,
            "metrics-export-interval": 1,
            "mgmt-port-secure": "somestring",
            "name": "somestring",
            "region": "somestring",
            "zone": "somestring"
        },
        {
            "cluster": "somestring",
            "host": "somestring",
            "location": "somestring",
            "management-interface": true,
            "metrics-export-interval": 1,
            "mgmt-port-secure": "somestring",
            "name": "somestring",
            "region": "somestring",
            "zone": "somestring"
        }
    ]
}

Responses

200

Type: CreateDeviceResponse

Example:

{
    "device": {
        "a10-url": "somestring",
        "cluster": "somestring",
        "device-oper-status": {
            "a10-url": "somestring",
            "uuid": "somestring"
        },
        "ha-primary": 1,
        "host": "somestring",
        "license-state": "somestring",
        "location": "somestring",
        "management-interface": 1,
        "metrics-export-interval": 1,
        "mgmt-port-disable": 1,
        "mgmt-port-secure": 1,
        "mgmt-secure-port-disable": 1,
        "name": "somestring",
        "region": "somestring",
        "registration-state": "somestring",
        "uuid": "somestring",
        "zone": "somestring"
    }
}

POST ``/api/v2/hpcapi/v3/provider/{provider-name}/device/{device-name}/licenseinfo``

Parameters

Name

Located in

Required

Type

Format

Properties

Description

provider-name

path

Yes

string

Provider name. Example value =’root’

device-name

path

Yes

string

Device name. Example value =’test-device’

Request

Headers

authorization: Generated header parameter. Example value ='Basic c3VwZXItYWRtaW46cGFzc3dvcmQ='
provider: Generated header parameter. Example value ='root'

Body

Name

Required

Type

Format

Properties

Description

licenseinfo

No

Licenseinfo

{
    "licenseinfo": {
        "device-bandwidth": 1,
        "lic-key": "somestring",
        "license-state": "somestring",
        "license-type": "somestring"
    }
}

Responses

200

Type: LicenseinfoResponse

Example:

{
    "licenseinfo": {
        "a10-url": "somestring",
        "device-bandwidth": "somestring",
        "lic-key": "somestring",
        "license-state": "somestring",
        "license-type": "somestring",
        "uuid": "somestring"
    }
}

Data Structures

Cluster Response Model Structure

Name

Required

Type

Format

Properties

Description

cluster

No

ClusterResponse_Cluster

Cluster Response Cluster Model Structure

Name

Required

Type

Format

Properties

Description

a10-url

No

string

cluster-uuid

No

string

display-name

No

string

manual-pt-mapping

No

integer

int32

name

No

string

provision-state

No

string

type

No

string

uuid

No

string

Create Cluster Request Model Structure

Name

Required

Type

Format

Properties

Description

description

No

string

display-name

No

string

name

No

string

type

No

string

Create Cluster Request Wrapper Model Structure

Name

Required

Type

Format

Properties

Description

cluster

No

CreateClusterrRequest

Create Cluster Response Model Structure

Name

Required

Type

Format

Properties

Description

cluster

No

CreateClusterrResponse_Cluster

Create Cluster Response Cluster Model Structure

Name

Required

Type

Format

Properties

Description

a10-url

No

string

description

No

string

display-name

No

string

manual-pt-mapping

No

integer

int32

name

No

string

provision-state

No

string

type

No

string

uuid

No

string

Create Device Request Model Structure

Name

Required

Type

Format

Properties

Description

cluster

No

string

host

No

string

location

No

string

management-interface

No

boolean

metrics-export-interval

No

integer

int32

mgmt-port-secure

No

string

name

No

string

region

No

string

zone

No

string

Create Device Request Wrapper Model Structure

Name

Required

Type

Format

Properties

Description

device-list

No

array of CreateDeviceRequest

Create Device Response Model Structure

Name

Required

Type

Format

Properties

Description

device

No

CreateDeviceResponse_Device

Create Device Response Device Model Structure

Name

Required

Type

Format

Properties

Description

a10-url

No

string

cluster

No

string

device-oper-status

No

Device-oper-status

ha-primary

No

integer

int32

host

No

string

license-state

No

string

location

No

string

management-interface

No

integer

int32

metrics-export-interval

No

integer

int32

mgmt-port-disable

No

integer

int32

mgmt-port-secure

No

integer

int32

mgmt-secure-port-disable

No

integer

int32

name

No

string

region

No

string

registration-state

No

string

uuid

No

string

zone

No

string

Create Workflow Response Model Structure

Name

Required

Type

Format

Properties

Description

workflow

No

Workflow

Deregister Device Request Model Structure

Name

Required

Type

Format

Properties

Description

force-delete

No

boolean

Device-oper-status Model Structure

Name

Required

Type

Format

Properties

Description

a10-url

No

string

uuid

No

string

Device Response Model Structure

Name

Required

Type

Format

Properties

Description

device

No

DeviceResponse_Device

Device Response Device Model Structure

Name

Required

Type

Format

Properties

Description

a10-url

No

string

cluster

No

string

device-oper-status

No

DeviceResponse_Device_Device-oper-status

device-uuid

No

string

ha-primary

No

integer

int32

host

No

string

license-state

No

string

licenseinfo-list

No

array of Licenseinfo-list

location

No

string

management-interface

No

integer

int32

metrics-export-interval

No

integer

int32

mgmt-port-disable

No

integer

int32

mgmt-port-secure

No

integer

int32

mgmt-secure-port-disable

No

integer

int32

name

No

string

region

No

string

registration-state

No

string

uuid

No

string

zone

No

string

Device Response Device Device-oper-status Model Structure

Name

Required

Type

Format

Properties

Description

a10-url

No

string

clock-drift

No

string

network-connectivity

No

string

uuid

No

string

License Info Model Structure

Name

Required

Type

Format

Properties

Description

device-bandwidth

No

integer

int32

lic-key

No

string

license-state

No

string

license-type

No

string

License Info-list Model Structure

Name

Required

Type

Format

Properties

Description

a10-url

No

string

device-bandwidth

No

string

lic-key

No

string

license-state

No

string

license-type

No

string

uuid

No

string

License Info Response Model Structure

Name

Required

Type

Format

Properties

Description

licenseinfo

No

LicenseinfoResponse_Licenseinfo

License Info Response License Info Model Structure

Name

Required

Type

Format

Properties

Description

a10-url

No

string

device-bandwidth

No

string

lic-key

No

string

license-state

No

string

license-type

No

string

uuid

No

string

License Info Wrapper Model Structure

Name

Required

Type

Format

Properties

Description

licenseinfo

No

Licenseinfo

Object Workflow Response Model Structure

Name

Required

Type

Format

Properties

Description

resultSet

No

array of ObjectWorkflowResponse_ResultSet

resultSetCount

No

integer

int32

totalRecordsCount

No

integer

int32

Object Workflow Response Result Set Model Structure

Name

Required

Type

Format

Properties

Description

d46c162a-9fd4-11ea-b855-be926aaf4d07

No

ObjectWorkflowResponse_ResultSet_D46c162a-9fd4-11ea-b855-be926aaf4d07

Object Workflow Response Result Set_D46c162a-9fd4-11ea-b855-be926aaf4d07 Model Structure

Name

Required

Type

Format

Properties

Description

obj_id

No

string

obj_type

No

string

provider_id

No

string

status

No

string

status_message

No

string

tenant_id

No

string

workflow_created_on

No

integer

int64

workflow_id

No

string

workflow_type

No

string

Register Device Request Model Structure

Name

Required

Type

Format

Properties

Description

password

No

string

username

No

string

Register Device Request Wrapper Model Structure

Name

Required

Type

Format

Properties

Description

device

No

RegisterDeviceRequest

Workflow Model Structure

Name

Required

Type

Format

Properties

Description

uuid

No

string