Host Management

The following are the Reports REST APIs:

Status

The following table details the API Response code, status and, the HTTPS methods.

Status Code
Status
API's HTTPS Method or
HTTPS Method

200

OK

GET

202

Accepted

POST

PUT

DELETE

400

Bad Request

GET

POST

PUT

DELETE

401

Unauthorized

GET

POST

PUT

DELETE

403

Forbidden

GET

POST

PUT

DELETE

404

Not Found

GET

POST

PUT

DELETE

405

Method Not Allowed

GET

POST

PUT

DELETE

500

Internal Server Error

GET

POST

PUT

DELETE

Get Report View by Selection

Resource Name

/report/reportview

Description

Enables you to get a report view by individual selection

https Method

GET

URL

https://dcnm-ip/fm/fmrest/report/reportview

Parameter

Parameter
Type
Description

group

S

URI Parameter

selection

S

URI Parameter

reportFilter

S

URI Parameter

sortDownStr

S

URI Parameter

userName

S

URI Parameter

isAdmin

S

URI Parameter

Return Value

Format: JSON

Type: Object

Attribute Name
Type
Description

ReportDO

O

Report Object

Get Report Jobs

Resource Name

/report/reportjobs

Description

Enables you to get a report of Jobs

https Method

GET

URL

https://dcnm-ip/fm/fmrest/report/reportjobs

Parameter

Parameter
Type
Description

sortDownStr

S

URI Parameter

userName

S

URI Parameter

isAdmin

S

URI Parameter

Return Value

Format: JSON

Type: Long

Attribute Name
Type
Description

SortedReportJobDO

O

Sorted Report for Jobs Object

Bulk Import Hosts

Resource Name

/rest/pmn/host/import

Description

Creates a new host instance.

https Method

POST

URL

https://dcnm-ip/rest/pmn/host/import

Parameter

Parameter
Type
Description

String payload of CSV File

String

CSV data

Return Value

Format: JSON

Type: Long

Attribute Name
Type
Description

hostid

String

Unique id for the created Host Instance

Get Hosts

Resource Name

/rest/pmn/host/

Description

Get the host instances created.

https Method

GET

URL

https://dcnm-ip/rest/pmn/host/ -- get all Hosts

https://dcnm-ip/rest/pmn/host/{host_id} -- get Host with specific hostid

Parameter

Parameter
Type
Description

none

String

All hosts created

hostid

String

Request about a particular Host ID

Return Value

Format: JSON

Type: Long

Attribute Name
Type
Description

id

String

Unique id for the Host Instance

name

String

Name of the Host Instance

ipAddress

String

IP Address of the Host Instance

macAddress

String

Mac Address of the Host Instance

ethswitchId

String

Unique id of the device the host is connected to

interfaceId

String

Unique id of the interface instance of the device the host is connected to.

Delete Hosts

Resource Name

/rest/pmn/host/

Description

Deletes the host instances created.

https Method

DELETE

URL

https://dcnm-ip/rest/pmn/host/<hostid>

Parameter

Parameter
Type
Description

 

 

 

Return Value

Format: JSON

Type: Long

Attribute Name
Type
Description

 

 

 

Edit/Update Hosts

Resource Name

/rest/pmn/host/

Description

Delete the host instances created.

https Method

PUT

URL

https://dcnm-ip/rest/pmn/host/<hostid>

Parameter

Parameter
Type
Description

 

 

 

Return Value

Format: JSON

Type: Long

Attribute Name
Type
Description