Contents

Dell PowerFlex Manager V3.6 Solution API Guide PDF

1 of 134
1 of 134

Summary of Content for Dell PowerFlex Manager V3.6 Solution API Guide PDF

Dell EMC PowerFlex Manager API Guide

Version 3.6

July 2022 Rev. 5.0

Introduction The target audience for this guide includes programmers responsible for integrating third-party software with PowerFlex Manager.

This document applies to PowerFlex Manager release 3.6 and earlier. It is assumed that you are familiar with REST, and programmatic interaction with REST APIs. Any programming languages can be used with these APIs. However, the code examples that are contained in this guide are written in Ruby. XML is also used extensively for these examples.

The available REST methods are explained in Appendix A - API reference.

Most of the REST methods exchange complex data models within the HTTP requests and responses. Depending on the preference, these data models are represented as either XML or JSON. The model structure is contained in Appendix B - Model reference.

API documentation for release 3.7 and later is available on the Dell Technologies Developer Portal.

Title Link to PowerFlex Manager API

PowerFlex Manager API Dell Technologies Developer Portal 1. Search for PowerFlex Manager. 2. Select the API for PowerFlex Manager.

PowerFlex Manager provides the management and orchestration functionality for PowerFlex rack. References to PowerFlex Manager in this document apply only if you have a licensed version of PowerFlex Manager. For more information, contact Dell Technologies Sales. If your system uses Vision Intelligent Operations software, work with your Dell Technologies sales team to obtain a PowerFlex Manager license.

Dell EMC PowerFlex Manager was previously known as Dell EMC VxFlex Manager. Similarly, Dell EMC PowerFlex was previously known as Dell EMC VxFlex OS. References in the documentation will be updated over time.

See the Glossary for terms, definitions, and acronyms.

1

2 Introduction

Revision history

Date Document revision Description of changes

July 2022 5.0 Updated Authentication header on page 6 for EH-3639.

November 2020 4.0 Updated for the PowerFlex Manager 3.6 release.

Added: /Log GET LocalizedLogMessage

June 2020 3.0 Updated for the PowerFlex Manager 3.5 release.

Added: /AlertConnector/registersettings

POST /AlertConnector/settings GET /AlertConnector/suspend POST /AlertConnector/Deregister POST /AlertConnector/enablesnmpandipmi

POST /AlertConnector/starttimerservice

POST /AlertConnector/testidracalerts

POST /AlertConnector/getallsnmpalerts

GET /AlertConnector/updatesnmpalerts

POST /TroubleshootingBundle/export

POST /TroubleshootingBundle/test POST TroubleshootingBundleParams SRSConnectorSettings emailServerConfig SRSConnectorTestAlerts UpdateSnmpAlerts selectedAlerts

July 2019 2.0 Updated the DeploymentStatusType data model

February 2019 1.0 PowerFlex Manager 3.1 release

2

Revision history 3

Overview PowerFlex Manager provides IT operations management for PowerFlex rack. It increases efficiency by reducing time-consuming manual tasks that are required to manage PowerFlex rack and PowerFlex appliance operations. Using PowerFlex Manager, you can deploy and manage new and preexisting system environments.

Two essential concepts in PowerFlex Manager are the ServiceTemplate model and the Deployment model. A ServiceTemplate model describes a blueprint for provisioning and configuring a collection of devices as a named unit, also known as a service. The Deployment model uses a ServiceTemplate model to physically realize what service the service template describes. While the names deployment and service are synonymous, PowerFlex Manager uses the term service while the REST API uses the term Deployment.

PowerFlex Manager is distributed as a virtual appliance running a collection of interacting web applications that communicate through the REST interfaces. An extra web application, the PowerFlex Manager UI, also resides on the virtual appliance, providing a full browser-based GUI access to PowerFlex Manager. This PowerFlex Manager UI interacts with PowerFlex Manager through the same REST interfaces that are described in this guide.

If you have a licensed version of PowerFlex Manager, PowerFlex Manager can be integrated with any custom UI or accessed through programs for an enhanced automation experience.

3

4 Overview

Resource endpoint URL An example of a resource endpoint is: https://Api/V1/ServiceTemplate From this example, API endpoints are accessible over port 443.

All URI paths are prefixed with /Api/V1/ where V1 is the current API version.

Following the prefix above the remainder of the URI path (endpoint) has the form / / ? .

Where action and query are optional, and resource is one of the following resources:

Authenticate Credential Deployment DeviceGroup DHCP DiscoveryRequest FirmwareRepository ManagedDevice Network NTP Proxy Server ServiceTemplate Timezone User WizardStatus

Each of these resources is fully detailed in Appendix A - API reference. The API reference shows the following information for each resource: HTTP methods Optional actions Query parameters relevant payloads for POST and PUT methods

4

Resource endpoint URL 5

Authentication header All API requests require three custom HTTP headers for authentication.

These headers are: X-dell-auth-key X-dell-auth-signature X-dell-auth-timestamp To build the headers, perform these steps:

1. Call POST /Api/V1/Authenticate.

The response includes the apiKey and apiSecret, which are required to generate the headers.

Field Description

apiKey API key required to build the request string.

Sample value: "2993d0042db9e50586b60943"

apiSecret API secret required to compute the digest.

Sample value: "fff0bbe6ef380ef84ac2df165fd40f094ef48780728a55b9"

Sample JSON request:

{ "domain": "VXFMLOCAL", "password": "admin", "userName": "admin" }

Sample JSON response:

{ "apiKey": "2993d0042db9e50586b60943", "apiSecret": "fff0bbe6ef380ef84ac2df165fd40f094ef48780728a55b9", "domain": "VXFMLOCAL", "role": "Administrator", "userId": 1, "userName": "admin" }

2. Concatenate the five values listed below to create the request string:

Field Description

apiKey API key from the POST /Api/V1/Authenticate call.

Sample value: "2993d0042db9e50586b60943"

httpMethod HTTP method, such as GET, POST, PUT, or DELETE

Sample value: "GET"

uriPath URI path without the query parameters. NOTE: Make sure the query parameters are not included.

5

6 Authentication header

Field Description

Sample value: "/Api/V1/Network"

userAgent User agent header that the client sends as part of the request.

Sample value: "rest-client/2.1.0 (linux-gnu x86_64) ruby/ 2.4.1p111"

timestamp Unix timestamp for the current time.

Sample value for 2021-01-06 17:43:51 -0600: "1609976631"

The request string for the above sample values would be:

"2993d0042db9e50586b60943:GET:/Api/V1/Network:"rest-client/2.1.0 (linux-gnu x86_64) ruby/ 2.4.1p111:1609976631"

3. Compute a Base64 encoded SHA-256 HMAC digest of the concatenated request string using the apiSecret obtained from the /Api/V1/Authenticate call by performing these steps:

Step Description

Step 1: Compute the SHA-256 HMAC digest Compute the SHA-256 HMAC digest with OpenSSL. The digest is based on the apiSecret and the concatenated request string you created earlier.

Sample code:

hash_str = OpenSSL::HMAC.digest('sha256', apiSecret, requestString)

Sample execution value:

[25] pry(main)> hash_str = OpenSSL::HMAC.digest('sha256', apiSecret, requestString) => "!\x01p\xA6\xFF\xC2h{/ \xF1\xB4\xF6\xA0/8\xA1\xD1\xAD\xF8\f\xCAG \x1E\xF3/\xCC\xA84\xD1\x02\xF2\x84"

Step 2: Base64 encode the HMAC digest Create the Base64 encoded value that is based on the digest hash code created with OpenSSL.

Sample code:

signature = Base64.strict_encode64(hash_str)

Sample execution value:

[26] pry(main)> Base64.strict_encode64(hash_str) => "IQFwpv/ CaHsv8bT2oC84odGt+AzKRx7zL8yoNNEC8oQ="

The signature value shown above applies to the /Api/V1/ Network API call. Any call to this API should have a matching value.

4. Set the three custom HTTP headers.

The custom HTTP headers are based on values produced by the previous steps:

Authentication header 7

Header Description

x-dell-auth-key Must be set to the apiKey

x-dell-auth-signature Must be set to the signature

x-dell-auth-timestamp Must be set to the timestamp

Here is a Ruby example that shows the process of generating the custom HTTP headers:

apiKey = '34b3577f7c3c03174a9a506b' apiSecret = '9a6d9692ba64142e6a1934f9be994f3b0ae63959a6132c8b' timestamp = Time.now.to_i.to_s

# Concatenate the following values requestString = "%s:%s:%s:%s:%s" % [apiKey,httpMethod,uriPath,userAgent,timestamp]

# Compute a digest on concatenated string using apiSecret hash_str = OpenSSL::HMAC.digest('sha256',apiSecret,requestString) signature = Base64.strict_encode64(hash_str)

headers['x-dell-auth-key'] = apiKey headers['x-dell-auth-signature'] = signature headers['x-dell-auth-timestamp'] = timestamp

NOTE: If the two system clocks communicating with each other are not synchronized because of the timestamp

component, authentication of future requests may fail. It is essential to synchronize the system clocks of the two systems.

8 Authentication header

Generic query parameter Many GET methods which return a list of objects support generic query parameters for filtering, sorting, and paging.

These methods are indicated in Appendix A - API reference but the detailed syntax is described here.

filter= , , , operator is one of ( eq, co ) where valid filter columns are listed for each supporting method in the API reference Examples:

"eq,columnName,columnValue"

To include resources where columnName is columnValue.

"eq,columnName,columnValue,columnValue2[,columnValue3]"

To include resources where columnName is columnValue OR columnValue2.

"eq,columnName,"

To include resources where columnName is empty.

"eq,columnName,,columnValue[,columnValue2]"

To include resources where columnName is empty OR columnValue.

"co,columnName,columnValue"

To include resources where columnName contains columnValue:

sort = [-] , where valid sort columns are listed for each supporting method in the API reference and a minus sign preceding the column name indicates descending order

offset = default is 0

limit = default is 50

Dates in query strings Some of the columns that are sortable or filterable are dates such as createdDate. When using the filter parameter with date strings, only the eq operator is valid. The format for these date strings is:

dd-MM-yyyy

For example: 30-07-2015

6

Generic query parameter 9

HTTP message body HTTP requests and responses support both XML and JSON content types. The examples used throughout this document show HTTP body content in XML form. The represented data models that are accepted and returned from the API calls can be complex.

The structure of these data models is detailed in Appendix B - Model reference in a language-independent representation.

It is possible to craft, for example, an XML request body from this reference documentation. However, a more convenient method is to GET an existing object from PowerFlex Manager in either a (XML or JSON) representation. You can save it to a file for use as a skeleton for future requests involving that model type.

Since a fresh system does not have any existing deployments, a Deployment model is shown. It is only a skeleton because it is lacking the essential ServiceTemplate content that would make it useful. For more information, see the usage example called Deploy a Service.

Ottomatic 1 test REST deployment false false false false false false false false false false false false false false false false

Message body validation Message bodies are subject to a wide range of validations. Capturing every validation rule is beyond the scope of this document but a few general rules are worth noting.

In general, validation failures generate exceptions and structured messages to isolate the violation. See the section on Exception handling for more details. Most validation exceptions return a 400 HTTP response, but some API methods generate specific HTTP response codes to indicate particular exceptions. The response codes are listed in the API reference in the Appendix.

Uniqueness validations - many models require unique names. Notable models include ServiceTempate, Deployment, Network, User. This violation returns a 409 HTTP response in these cases.

Relationship constraints - an exception occurs when you try, for example, to delete an entity that is in use by another entity. If a ServiceTemplate contains a server component, and a hostname is supplied with a hostname_template (hostname

generator), a validation exception is not generated. The preference is to use the hostname_template.

7

10 HTTP message body

Exception handling When an HTTP error code is returned the response payload contains information about the error.

An exception response was intentionally generated by trying to get a ServiceTemplate with an id that does not exist. In this case, the HTTP response was 404 and the XML response is below. See Appendix A - API reference for the relevant HTTP responses that is returned from each REST endpoint.

Here is an example of the code that is used to catch the exception and reported error:

AsmManagerMessages ASM0042 ERROR USER_FACING Unable to find the Template Id: ABC. Make sure that a correct Template Id is entered and retry the operation. Template Ids are case sensitive. Verify the list of devices under the Summary tab to make sure whether or not the Template already exists. The Template Id cannot be found. ASM Manager 2015-03-10T14:34:24.866Z 0

require 'ASMConfig'

templateId = "ABC" // bogus id url = ASM::API::URI("/ServiceTemplate/%s"%templateId)

begin response = ASM::API::sign { RestClient.get url } rescue RestClient::Exception => e print "Got exception with status: %d\n" % e.response.code print "%s\n" % e.response end

8

Exception handling 11

Appendix A - API reference

/AlertConnector/deregister POST

Description

De-registers the Secure Remote Services connector.

Method

post

Response Status Codes

HTTP Status Code Reason

200 Good request

400 Invalid parameter values

401 Login information not specified

401 Forbidden (user does not have privileges)

500 Internal server error

/AlertConnector/enablesnmpandipmi POST

Description

Enables SNMP and IPMI.

Method

post

Response Status Codes

HTTP Status Code Reason

200 Good request

400 Invalid parameter values

401 Login information not specified

401 Forbidden (user does not have privileges)

9

12 Appendix A - API reference

HTTP Status Code Reason

500 Internal server error

/AlertConnector/getallsnmpalerts GET

Description

Retrieves all the SNMP alerts.

Method

get

Response Class

SnmpAlertResponse

Response Content-Type: application/xml, application/json

Response Status Codes

HTTP Status Code Reason

200 Good request

400 Invalid parameter values

401 Login information not specified

401 Forbidden (user does not have privileges)

500 Internal server error

/AlertConnector/registersettings POST

Description

Saves the Secure Remote Services connector configuration. This can be performed by Admin or Read-only users.

Method

post

Response Class

SRSConnectorSettings

Response Content-Type: application/xml, application/json

Appendix A - API reference 13

Parameters

Parameter Value Description Default Value Parameter Type Data Type

body (required) Secure Remote Services connector configuration to save

N/A body SRSConnectorSetti ngs

Response Status Codes

HTTP Status Code Reason

200 Good request

400 Invalid parameter values

401 Login information not specified

401 Forbidden (user does not have privileges)

500 Internal server error

/AlertConnector/settings GET

Description

Retrieves the current configuration for Secure Remote Services, and returns the object from registersettings. This can be performed by Admin or Read-only users.

Method

get

Response Class

SRSConnectorSettings

Response Content-Type: application/xml, application/json

Response Status Codes

HTTP Status Code Reason

200 Good request

400 Invalid parameter values

401 Login information not specified

401 Forbidden (user does not have privileges)

500 Internal server error

14 Appendix A - API reference

/AlertConnector/starttimerservice POST

Description

Starts the Secure Remote Services Connector Timer.

Method

post

Response Status Codes

HTTP Status Code Reason

200 Good request

400 Invalid parameter values

401 Login information not specified

401 Forbidden (user does not have privileges)

500 Internal server error

/AlertConnector/suspend/{duration} POST

Description

Suspends the alerts for a specified amount of time.

Method

post

Parameters

Parameter Value Description Default Value Parameter Type Data Type

duration (required) Specifies the amount the time.

Time duration format: yyyy- MM-dd HH:mm:ss.SSSSSS

N/A path string

Response Status Codes

HTTP Status Code Reason

200 Good request

400 Invalid parameter values

Appendix A - API reference 15

HTTP Status Code Reason

401 Login information not specified

401 Forbidden (user does not have privileges)

500 Internal server error

/AlertConnector/testidracalerts POST

Description

Generates the IDRAC test alerts for all configured IDRACs.

Method

post

Parameters

Parameter Value Description Default Value Parameter Type Data Type

body (required) IDRAC test alerts for all the configured IDRACs to generate

N/A body SRSConnectorTest Alerts

Response Status Codes

HTTP Status Code Reason

200 Good request

400 Invalid parameter values

401 Login information not specified

401 Forbidden (user does not have privileges)

500 Internal server error

/AlertConnector/updatesnmpalerts POST

Description

Updates the srs_sent field of the SNMP alerts.

Before running SNMP alert updates, retrieve all the SNMP alerts. See /AlertConnector/getallsnmpalerts GET on page 13 for details.

Method

post

16 Appendix A - API reference

Parameters

Parameter Value Description Default Value Parameter Type Data Type

body (required) srs_sent field of the SNMP alerts to update

N/A body UpdateSnmpAlerts

Response Status Codes

HTTP Status Code Reason

200 Good request

400 Invalid parameter values

401 Login information not specified

401 Forbidden (user does not have privileges)

500 Internal server error

/Authenticate/ POST

Description

Confirm User access credentials.

Method

post

Response Class

AuthenticateResponse

Response Content-Type: application/json, application/xml

Parameters

Parameter Value Description Default Value Parameter Type Data Type

body (required) Description of user to authenticate.

N/A body AuthenticateReque st

Response Status Codes

HTTP Status Code Reason

201 Authentication successful

401 User not found, domain not found, or password does not match

Appendix A - API reference 17

/Credential/ GET

Description

Retrieve a list of all credentials.

Method

get

Response Class

credentialList

Response Content-Type: application/xml, application/json

Parameters

Parameter Value Description Default Value Parameter Type Data Type

type N/A Filter on credential type.

N/A query com.dell.asm.encry ptionmgr.client.Cre dentialType

sort N/A Specify sort columns in a comma-separated list of column names to sort. Default order is ascending. Column name can be prefixed with a minus sign to indicate descending for that column.

N/A query string

filter N/A Specify filter criteria, Example co,label,default

N/A query array

offset N/A Specify pagination offset.

0 query integer

limit N/A Specify page limit, cannot exceed the system maximum limit.

50 query integer

Response Status Codes

HTTP Status Code Reason

200 OK

18 Appendix A - API reference

/Credential/ POST

Description

Add a new credential.

CAUTION: This API only supports XML for request payloads. Both JSON and XML are supported for response

payloads.

Method

post

Response Class

asmCredential

Response Content-Type: application/xml, application/json

Parameters

Parameter Value Description Default Value Parameter Type Data Type

body (required) Credential to create

N/A body asmCredential

Response Status Codes

HTTP Status Code Reason

201 Credential created.

400 Bad Request, verify that credential data object is correct.

/Credential/{id} GET

Description

Find credential by type and id.

Method

get

Response Class

asmCredential

Response Content-Type: application/xml, application/json

Appendix A - API reference 19

Parameters

Parameter Value Description Default Value Parameter Type Data Type

id (required) Id of credential to retrieve

N/A path string

Response Status Codes

HTTP Status Code Reason

200 OK

404 Credential not found

/Credential/{id} PUT

Description

Updates an existing credential.

CAUTION: This API only supports XML for request payloads. Both JSON and XML are supported for response

payloads.

Method

put

Response Class

asmCredential

Response Content-Type: application/xml, application/json

Parameters

Parameter Value Description Default Value Parameter Type Data Type

body (required) Credential to update

N/A body asmCredential

id (required) Id of credential to update

N/A path string

Response Status Codes

HTTP Status Code Reason

200 Update completed successfully.

400 Bad Request, verify that credential data object is correct.

404 Credential to be updated was not found.

20 Appendix A - API reference

/Credential/{id} DELETE

Description

Deletes an existing credential.

Method

delete

Response Class

void

Response Content-Type: application/xml, application/json

Parameters

Parameter Value Description Default Value Parameter Type Data Type

id (required) Id of credential to delete

N/A path string

Response Status Codes

HTTP Status Code Reason

204 Delete completed successfully.

400 Bad Request, verify credential type and id is correct.

/DHCP/ GET

Description

Retrieve DHCP settings from virtual appliance.

Method

get

Response Class

dhcpSettings

Response Content-Type: application/json, application/xml

Appendix A - API reference 21

Response Status Codes

HTTP Status Code Reason

200 Retrieved DHCP settings from appliance successfully.

500 Unable to get DHCP settings from the appliance.

/DHCP/ PUT

Description

Apply DHCP settings on virtual appliance.

Method

put

Response Class

void

Response Content-Type: application/json, application/xml

Parameters

Parameter Value Description Default Value Parameter Type Data Type

body (required) DHCPEntity object that needs to be set on appliance.

N/A body dhcpSettings

Response Status Codes

HTTP Status Code Reason

204 Successfully changed the DHCP settings.

500 Unable to change DHCP settings on the appliance.

/Deployment/ GET

Description

Retrieve all Deployment objects with filter, sort, paginate which returns Array of Deployment.class.

Method

get

22 Appendix A - API reference

Response Class

[ Deployment ]

Response Content-Type: application/xml, application/json

Parameters

Parameter Value Description Default Value Parameter Type Data Type

sort N/A Valid sort columns: name,createdBy,cr eatedDate,updated By,updatedDate,ex pirationDate,deploy mentDesc,marshall edTemplateData,he alth

N/A query string

filter N/A Valid filter columns: name,createdBy,cr eatedDate,updated By,updatedDate,ex pirationDate,deploy mentDesc,marshall edTemplateData,he alth

N/A query array

offset N/A Pagination Offset 0 query integer

limit N/A Page Limit 50 query integer

full N/A Use full templates including resources in response.

false query boolean

Response Status Codes

HTTP Status Code Reason

200 All Deployment retrieved on filter, sort, paginate.

/Deployment/ POST

Description

Create new Deployment.

Method

post

Response Class

Deployment

Appendix A - API reference 23

Response Content-Type: application/xml, application/json

Parameters

Parameter Value Description Default Value Parameter Type Data Type

body N/A Deployment to create

N/A body Deployment

Response Status Codes

HTTP Status Code Reason

201 Deployment created.

400 Invalid parameters to create Deployment or problems with the Resource Adapters.

409 Deployment already exists.

/Deployment/{id} GET

Description

Retrieve Deployment based on deployment ID.

Method

get

Response Class

Deployment

Response Content-Type: application/xml, application/json

Parameters

Parameter Value Description Default Value Parameter Type Data Type

id (required) Deployment Id (String)

N/A path string

Response Status Codes

HTTP Status Code Reason

200 Deployment retrieved.

404 Deployment not found.

24 Appendix A - API reference

/Deployment/{id} PUT

Description

Update Deployment.

Method

put

Response Class

Deployment

Response Content-Type: application/xml, application/json

Parameters

Parameter Value Description Default Value Parameter Type Data Type

body N/A Deployment to update

N/A body Deployment

id (required) Deployment Id (String)

N/A path string

Response Status Codes

HTTP Status Code Reason

204 Deployment updated.

400 Invalid parameters to update Deployment or problem with the Resource Adapters.

404 Deployment not found.

/Deployment/{id} DELETE

Description

Delete Deployment -- this operation is idempotent. The operation removes the specified deployment from the appliance, but does not tear down the cluster resources.

Method

delete

Appendix A - API reference 25

Response Class

void

Response Content-Type: application/xml, application/json

Parameters

Parameter Value Description Default Value Parameter Type Data Type

id (required) Deployment Id (String)

N/A path string

Response Status Codes

HTTP Status Code Reason

204 Deployment deleted.

500 Unable to delete Deployment.

/Deployment/{id}/cancel POST

Description

Cancel Deployment.

Method

post

Response Class

Deployment

Response Content-Type: application/xml, application/json

Parameters

Parameter Value Description Default Value Parameter Type Data Type

body N/A Deployment to cancel

N/A body Deployment

id (required) Deployment Id (String)

N/A path string

Response Status Codes

HTTP Status Code Reason

204 Deployment canceled.

26 Appendix A - API reference

HTTP Status Code Reason

400 Invalid parameters to cancel Deployment or problem with the Resource Adapters.

404 Deployment not found.

/Deployment/{id}/firmware/compliancereport/ GET

Description

Returns an Array of FirmwareComplianceReports for the Devices that are in the Deployment.

Method

get

Response Class

FirmwareComplianceReport

Response Content-Type: application/xml, application/json

Parameters

Parameter Value Description Default Value Parameter Type Data Type

id (required) N/A path string

Response Status Codes

HTTP Status Code Reason

401 No login information specified in the request.

403 User does not have privileges to access this operation.

500 Internal Error, contact your system administrator.

/Deployment/device/{deviceId} GET

Description

Retrieve all Deployments for device.

Method

get

Appendix A - API reference 27

Response Class

[ Deployment ]

Response Content-Type: application/xml, application/json

Parameters

Parameter Value Description Default Value Parameter Type Data Type

deviceId (required) N/A path string

Response Status Codes

HTTP Status Code Reason

200 Deployments retrieved.

404 Deployments not found.

/Deployment/export/csv GET

Description

Exports all Deployments in .csv format.

Method

get

Response Class

void

Response Content-Type: application/octet-stream

Response Status Codes

HTTP Status Code Reason

401 No login information specified in the request.

403 User does not have privileges to access this operation.

500 User Log Internal Error, contact your system administrator.

28 Appendix A - API reference

/Deployment/filter/{numOfDeployments} POST

Description

Find available servers for template components.

Method

post

Response Class

DeploymentFilterResponse

Response Content-Type: application/xml, application/json

Parameters

Parameter Value Description Default Value Parameter Type Data Type

body N/A Service template N/A body ServiceTemplate

numOfDeployments N/A Number of deployments

N/A path integer

unique N/A If true (the default), only assign a server to one component per deployment. Otherwise the same server may be assigned to multiple components.

true query boolean

Response Status Codes

HTTP Status Code Reason

200 DeploymentFilterResponse retrieved.

400 Invalid Parameters to getAvailableServers.

500 Unable to find available servers.

/Deployment/network/{networkId} GET

Description

Retrieve all Deployments for network.

Appendix A - API reference 29

Method

get

Response Class

[ Deployment ]

Response Content-Type: application/xml, application/json

Parameters

Paramet er

Value Description Default Value Parameter Type Data Type

networkId (required) N/A N/A path string

Response Status Codes

HTTP Status Code Reason

200 Deployments retrieved.

404 Deployments not found.

/Deployment/serverNetworking/{serviceId}/ {serverId} GET

Description

Returns the networks that a server in a deployment is using.

Method

get

Response Class

ServerNetworkObjects

Response Content-Type: application/xml, application/json

Parameters

Parameter Value Description Default Value Parameter Type Data Type

serviceId (required) N/A path string

serverId (required) N/A path string

30 Appendix A - API reference

Response Status Codes

HTTP Status Code Reason

401 No login information specified in the request.

403 User does not have privileges to access this operation.

500 Internal Error, contact your system administrator.

/Deployment/summaries GET

Description

Retrieve all Deployment objects with filter, sort, paginate which returns Array of Deployment.class.

Method

get

Response Class

[ Deployment ]

Response Content-Type: application/xml, application/json

Parameters

Parameter Value Description Default Value Parameter Type Data Type

sort N/A Valid sort columns: name,createdBy,cr eatedDate,updated By,updatedDate,ex pirationDate,deploy mentDesc,marshall edTemplateData,he alth

N/A query string

filter N/A Valid filter columns: name,createdBy,cr eatedDate,updated By,updatedDate,ex pirationDate,deploy mentDesc,marshall edTemplateData,he alth

N/A query array

offset N/A Pagination Offset 0 query integer

limit N/A Page Limit 50 query integer

Appendix A - API reference 31

Response Status Codes

HTTP Status Code Reason

200 All Deployment retrieved on filter, sort, paginate.

/Deployment/users DELETE

Description

Delete User objects from Deployment objects.

Method

delete

Response Class

void

Response Content-Type: application/xml, application/json

Parameters

Paramet er

Value Description Default Value Parameter Type Data Type

userId N/A Valid UserIds N/A query array

Response Status Codes

HTTP Status Code Reason

204 User objects deleted from Deployment.

500 Unable to delete User objects from Deployment.

/DeviceGroup/ GET

Description

Retrieve all DeviceGroup from Inventory with filter, sort, paginate, return DeviceGroup which contains list of Managed Devices and User if it exists.

Method

get

32 Appendix A - API reference

Response Class

[ DeviceGroup ]

Response Content-Type: application/xml, application/json

Parameters

Parameter Value Description Default Value Parameter Type Data Type

sort N/A Valid sort columns: name,description,cr eatedBy,createdDa te,updatedBy,updat edDate

N/A query string

filter N/A Valid filter columns: name,description,u sers,devices,create dBy,updatedBy,cre atedDate,updatedD ate

N/A query array

offset N/A Pagination Offset 0 query integer

limit N/A Page Limit 50 query integer

Response Status Codes

HTTP Status Code Reason

200 DeviceGroup retrieved from inventory on filter, sort, paginate.

/DeviceGroup/ POST

Description

Create DeviceGroup in Inventory.

Method

post

Response Class

DeviceGroup

Response Content-Type: application/xml, application/json

Parameters

Parameter Value Description Default Value Parameter Type Data Type

body N/A N/A body DeviceGroup

Appendix A - API reference 33

Response Status Codes

HTTP Status Code Reason

201 DeviceGroup created in inventory.

400 Invalid DeviceGroup object to create in inventory, first error encountered error causes an error response to return. Call does not return a list of errors.

409 DeviceGroup already exists in inventory, first encountered error causes an error response to return. Call does not return a list of errors.

/DeviceGroup/{refId} GET

Description

Retrieve DeviceGroup from Inventory based on refId.

Method

get

Response Class

DeviceGroup

Response Content-Type: application/xml, application/json

Parameters

Parameter Value Description Default Value Parameter Type Data Type

refId (required) Reference Id N/A path string

Response Status Codes

HTTP Status Code Reason

200 DeviceGroup retrieved from inventory.

404 DeviceGroup not found in inventory.

/DeviceGroup/{refId} PUT

Description

Update DeviceGroup in Inventory

34 Appendix A - API reference

Method

put

Response Class

DeviceGroup

Response Content-Type: application/xml, application/json

Parameters

Parameter Value Description Default Value Parameter Type Data Type

body N/A DeviceGroup to update

N/A body DeviceGroup

refId (required) Reference Id N/A path string

Response Status Codes

HTTP Status Code Reason

201 DeviceGroup updated in inventory.

400 Invalid DeviceGroup id.

404 DeviceGroup not found in inventory.

/DeviceGroup/{refId} DELETE

Description

Delete DeviceGroup from Inventory.

Method

delete

Response Class

Response

Response Content-Type: application/xml, application/json

Parameters

Parameter Value Description Default Value Parameter Type Data Type

refId (required) Reference Id N/A path string

Appendix A - API reference 35

Response Status Codes

HTTP Status Code Reason

204 DeviceGroup deleted from inventory.

400 Unable to delete DeviceGroup from inventory.

/DiscoveryRequest/ GET

Description

Retrieve an Array of DiscoveryRequest.

Method

get

Response Class

[ DiscoveryRequest ]

Response Content-Type: application/xml, application/json

Parameters

Parameter Value Description Default Value Parameter Type Data Type

sort N/A Valid sort columns: id,status,statusMes sage

N/A query string

filter N/A Valid filter columns: id,status,statusMes sage

N/A query array

offset N/A pagination offset N/A query integer

limit N/A page limit N/A query integer

Response Status Codes

HTTP Status Code Reason

400 Problem with a query parameter, check response for details.

/DiscoveryRequest/ POST

Description

Discover devices of IP range.

36 Appendix A - API reference

This is the primary API for discovering a device.

Method

post

Response Class

DiscoveryRequest

Response Content-Type: application/xml, application/json

Parameters

Parameter Value Description Default Value Parameter Type Data Type

body N/A N/A body DiscoveryRequest

Response Status Codes

HTTP Status Code Reason

202 Create the discovery resource.

400 Bad Request, verify Discovery request object is correct.

/DiscoveryRequest/{id} GET

Description

Retrieve Device from Inventory based on Id.

This API returns the DiscoveryRequest object. Once the DiscoveryRequest operation is complete, the DiscoveryRequest object is no longer retrievable. The API then returns a 404 status code. At this point, you need to look up the discovery device by using /ManagedDevice/{refId} GET (with a service tag).

Method

get

Response Class

DiscoveryRequest

Response Content-Type: application/xml, application/json

Parameters

Parameter Value Description Default Value Parameter Type Data Type

id (required) Discovery ID N/A path string

Appendix A - API reference 37

Response Status Codes

HTTP Status Code Reason

200 Discovery result retrieved for the job.

400 Bad Request, verify that sort, filter, and pagination are valid.

404 Job not found in the discovery.

/DiscoveryRequest/{id} DELETE

Description

Delete Device from Discover result -- this operation is idempotent.

Method

delete

Response Class

void

Response Content-Type: application/xml, application/json

Parameters

Parameter Value Description Default Value Parameter Type Data Type

id (required) Discovery ID N/A path string

Response Status Codes

HTTP Status Code Reason

204 Job deleted from inventory.

/DiscoveryRequest/discoveryresult/{id} GET

Description

Retrieve an Array of DiscoveryResults.

Method

get

38 Appendix A - API reference

Response Class

[ DiscoveryResult ]

Response Content-Type: application/xml, application/json

Parameters

Parameter Value Description Default Value Parameter Type Data Type

id (required) ref_id N/A path string

Response Status Codes

HTTP Status Code Reason

400 Problem with a query parameter, check response for details.

/DiscoveryRequest/listdevices POST

Description

Discover devices of IP range.

Method

post

Response Class

DiscoveryRequest

Response Content-Type: application/xml, application/json

Parameters

Parameter Value Description Default Value Parameter Type Data Type

body N/A N/A body DiscoveryRequest

Response Status Codes

HTTP Status Code Reason

202 Create the Discovery resource.

400 Bad Request, verify that Discovery request object is correct.

Appendix A - API reference 39

/FirmwareRepository/ GET

Description

Retrieve all FirmwareRepository with filter, sort, paginate which returns Array of firmwarerepository.class.

Method

get

Response Class

[ FirmwareRepository ]

Response Content-Type: application/xml, application/json

Parameters

Parameter Value Description Default Value Parameter Type Data Type

sort N/A Sort Column N/A query string

filter N/A Filter Criteria N/A query array

offset N/A Pagination Offset 0 query integer

limit N/A Page Limit 50 query integer

related N/A Hydrate related objects

N/A query boolean

bundles N/A Hydrate software bundle objects

N/A query boolean

components N/A Hydrate software component objects

N/A query boolean

Response Status Codes

HTTP Status Code Reason

200 All FirmwareRepository retrieved on filter, sort, paginate.

/FirmwareRepository/ POST

Description

Add a new firmware repository.

Method

post

40 Appendix A - API reference

Response Class

FirmwareInventory

Response Content-Type: application/xml, application/json

Parameters

Parameter Value Description Default Value Parameter Type Data Type

body (required) Firmware repository to create

N/A body FirmwareRepositor y

Response Status Codes

HTTP Status Code Reason

201 Firmware repository created.

400 Bad Request, verify that firmware repository data object is correct.

/FirmwareRepository/{id} GET

Description

Retrieve an individual firmware repository.

Method

get

Response Class

FirmwareRepository

Response Content-Type: application/xml, application/json

Parameters

Parameter Value Description Default Value Parameter Type Data Type

id (required) Repo Id N/A path string

related N/A Hydrate related objects

N/A query boolean

bundles N/A Hydrate software bundle objects

N/A query boolean

components N/A Hydrate software component objects

N/A query boolean

Appendix A - API reference 41

Response Status Codes

HTTP Status Code Reason

200 Retrieved.

400 Bad Request, verify that id is correct.

404 Bad Request, verify that id is correct.

/FirmwareRepository/{id} PUT

Description

Updates an existing FirmwareRepository.

Method

put

Response Class

FirmwareRepository

Response Content-Type: application/xml, application/json

Parameters

Parameter Value Description Default Value Parameter Type Data Type

body (required) FirmwareRepositor y to update

N/A body FirmwareRepositor y

id (required) Id of FirmwareRepositor y to update

N/A path string

Response Status Codes

HTTP Status Code Reason

200 Update completed successfully.

400 Bad Request, verify that credential data object is correct.

404 Credential to update was not found.

42 Appendix A - API reference

/FirmwareRepository/connection POST

Description

Tests the connection to a remote path.

Method

post

Response Class

FirmwareRepository

Response Content-Type: application/xml, application/json

Parameters

Parameter Value Description Default Value Parameter Type Data Type

body N/A N/A body FirmwareRepositor y

Response Status Codes

HTTP Status Code Reason

201 Connection to remote path successful.

/FirmwareRepository/esrslist GET

Description

Retrieve FirmwareRepositories available on Secure Remote Services.

Method

get

Response Class

[ FirmwareRepository ]

Response Content-Type: application/xml, application/json

Appendix A - API reference 43

Parameters

None

Response Status Codes

HTTP Status Code Reason

200 All FirmwareRepository retrieved on filter, sort, paginate.

/FirmwareRepository/softwarebundle/{id} GET

Description

Retrieve all FirmwareRepository with filter, sort, paginate which returns Array of firmwarerepository.class.

Method

get

Response Class

[ FirmwareRepository ]

Response Content-Type: application/xml, application/json

Parameters

Parameter Value Description Default Value Parameter Type Data Type

operatingSystem N/A Operating System N/A query string

vendorId N/A Vendor ID N/A query string

deviceId N/A Device ID N/A query string

subDeviceId N/A Sub Device ID N/A query string

componentId N/A Component ID N/A query string

subVendorId N/A Sub Vendor ID N/A query string

systemId N/A System ID N/A query string

type N/A Type N/A query string

Response Status Codes

HTTP Status Code Reason

200 All FirmwareRepository retrieved on filter, sort, paginate.

44 Appendix A - API reference

/FirmwareRepository/softwarecomponent GET

Description

Retrieve all FirmwareRepository with filter, sort, paginate which returns Array of firmwarerepository.class.

Method

get

Response Class

[ FirmwareRepository ]

Response Content-Type: application/xml, application/json

Parameters

Parameter Value Description Default Value Parameter Type Data Type

operatingSystem N/A Operating System N/A query string

vendorId N/A Vendor ID N/A query string

deviceId N/A Device ID N/A query string

subDeviceId N/A Sub Device ID N/A query string

componentId N/A Component ID N/A query string

subVendorId N/A Sub Vendor ID N/A query string

systemId N/A System ID N/A query string

type N/A Type N/A query string

Response Status Codes

HTTP Status Code Reason

200 All FirmwareRepository retrieved on filter, sort, paginate.

/Log GET

Description

Collect log entries.

Method

get

Appendix A - API reference 45

Response Class

LocalizedLogMessage

Response Content-Type: application/xml, application/json

Response Status Codes

HTTP Status Code Reason

200 Good request

400 Invalid parameter values

401 Login information not specified

401 Forbidden (user does not have privileges)

500 Internal server error

/ManagedDevice/ GET

Description

Retrieve all Devices from Inventory with filter.

Method

get

Response Class

[ ManagedDevice ]

Response Content-Type: application/xml, application/json

Parameters

Parameter Value Description Default Value

Parameter Type Data Type

sort N/A Valid sort columns: displayName,serviceTag,refId,health,refType,d eviceType,ipAddress,state,model,statusMessag e,createdDate,createdBy,updatedDate,updated By,healthMessage,compliant,infraTemplateDat e,infraTemplateId,serverTemplateDate,serverT emplateId,inventoryDate,complianceCheckDate ,discoveredDate,identityRef,vendor

N/A query string

filter N/A Valid filter columns: displayName,serviceTag,refId,health,refType,d eviceType,ipAddress,state,model,statusMessag e,createdDate,createdBy,updatedDate,updated By,healthMessage,compliant,infraTemplateDat e,infraTemplateId,serverTemplateDate,serverT

N/A query array

46 Appendix A - API reference

Parameter Value Description Default Value

Parameter Type Data Type

emplateId,inventoryDate,complianceCheckDate ,discoveredDate,identityRef,vendor,credId,serv ice

offset N/A Pagination Offset 0 query integer

limit N/A Page Limit 50 query integer

Response Status Codes

HTTP Status Code Reason

200 Devices retrieved from inventory on filter, sort, paginate.

/ManagedDevice/ POST

Description

Create Device in Inventory and return array of Managed Devices created.

This API is not intended to be used for discovery. Use the /DiscoveryRequest API to add inventory.

Method

post

Response Class

[ ManagedDevice ]

Response Content-Type: application/xml, application/json

Parameters

Parameter Value Description Default Value Parameter Type Data Type

body N/A N/A body com.dell.asm.asmc ore.asmmanager.cli ent.deviceinventory .ManagedDevice

Response Status Codes

HTTP Status Code Reason

201 Devices created in inventory.

400 Invalid Device to create in inventory, first error encountered error causes an error response to return. Call does not return a list of errors.

Appendix A - API reference 47

HTTP Status Code Reason

409 Device already exists in inventory, first error encountered error causes an error response to return. Call does not return a list of errors.

/ManagedDevice/{refId} GET

Description

Retrieve Device from Inventory based on refId.

Method

get

Response Class

ManagedDevice

Response Content-Type: application/xml, application/json

Parameters

Parameter Value Description Default Value Parameter Type Data Type

refId (required) Reference Id N/A path string

Response Status Codes

HTTP Status Code Reason

200 Device retrieved from inventory.

404 Device not found in inventory.

/ManagedDevice/{refId} PUT

Description

Update Device in Inventory.

This API is not intended to be used for discovery. Use the /DiscoveryRequest API to add inventory.

To update a device inventory, the best practice is to use a DELETE followed by an add of new inventory, instead of using PUT for /ManagedDevice.

Method

put

48 Appendix A - API reference

Response Class

void

Response Content-Type: application/xml, application/json

Parameters

Parameter Value Description Default Value Parameter Type Data Type

body N/A Device to update N/A body ManagedDevice

refId (required) Reference Id N/A path string

Response Status Codes

Table 1. Response Status Codes

HTTP Status Code Reason

201 Device updated in inventory.

400 Invalid Device.

404 Device not found in inventory.

/ManagedDevice/{refId} DELETE

Description

Delete Device from Inventory -- this operation is idempotent.

Method

delete

Response Class

ManagedDevice

Response Content-Type: application/xml, application/json

Parameters

Parameter Value Description Default Value Parameter Type Data Type

refId (required) Reference Id N/A path string

forceDelete N/A Force Delete false query boolean

Appendix A - API reference 49

Response Status Codes

HTTP Status Code Reason

204 Device deleted from inventory.

400 Unable to delete from inventory.

/ManagedDevice{refId}/firmware/ GET

Description

Retrieves the device firmware version from the inventory based on the refId.

Method

get

Response Class

firmwareDeviceInventory

Response Content-Type: application/xml, application/json

Parameters

Parameter Value Description Default Value Parameter Type Data Type

refid (required) Reference Id N/A path string

Response Status Codes

HTTP Status Code Reason

200 Devices retrieved from inventory on filter, sort, paginate.

/ManagedDevice/{refId}/firmware/ compliancereport/ GET

Description

Returns a FirmwareComplianceReports for the Device.

Method

get

50 Appendix A - API reference

Response Class

FirmwareComplianceReport

Response Content-Type: application/xml, application/json

Parameters

Parameter Value Description Default Value Parameter Type Data Type

refId (required) N/A N/A path string

Response Status Codes

HTTP Status Code Reason

401 No login information specified in the request.

403 User does not have privileges to access this operation.

500 Internal Error, contact your system administrator.

/ManagedDevice/count GET

Description

Retrieve Device total count.

Method

get

Response Class

integer

Response Content-Type: text/plain

Parameters

Parameter Value Description Default Value Parameter Type Data Type

filter N/A Filter Criteria N/A query array

Response Status Codes

HTTP Status Code Reason

200 Device Count retrieved from inventory.

Appendix A - API reference 51

/ManagedDevice/export/csv GET

Description

Exports all Devices in .csv format.

Method

get

Response Class

void

Response Content-Type: application/octet-stream

Response Status Codes

HTTP Status Code Reason

400 Bad Request, verify that input parameters are correct.

401 No login information specified in the request.

403 User does not have privileges to access this operation.

500 User Log Internal Error, contact your system administrator.

/ManagedDevice/firmware PUT

Description

Update Device Firmware.

Method

put

Response Class

void

Response Content-Type: application/xml, application/json

Parameters

Parameter Value Description Default Value Parameter Type Data Type

body N/A N/A body FirmwareUpdateRe quest

52 Appendix A - API reference

Response Status Codes

HTTP Status Code Reason

201 Device updated Firmware.

400 Invalid Device.

404 Device not found in inventory.

/ManagedDevice/puppet/{certName} GET

Description

Retrieve Device from Inventory based on certName.

Method

get

Response Class

ManagedDevice

Response Content-Type: application/xml, application/json

Parameters

Parameter Value Description Default Value Parameter Type Data Type

certName (required) Certificate Name N/A path string

Response Status Codes

HTTP Status Code Reason

200 Device retrieved from inventory.

404 Device not found in inventory.

/ManagedDevice/puppet/{certName} PUT

Description

Update Device in Inventory.

Method

put

Appendix A - API reference 53

Response Class

void

Response Content-Type: application/xml, application/json

Parameters

Parameter Value Description Default Value Parameter Type Data Type

body N/A Device to update N/A body ManagedDevice

certName (required) Certificate Name N/A path string

Response Status Codes

Table 2. Response Status Codes

HTTP Status Code Reason

201 Device updated in inventory.

400 Invalid Device.

404 Device not found in inventory.

/ManagedDevice/refresh POST

Description

Refresh Current Device Inventory for Device.

Method

post

Response Class

void

Response Content-Type: application/xml, application/json

Parameters

Parameter Value Description Default Value Parameter Type Data Type

deviceId N/A Device Inventory Ids

N/A query array

54 Appendix A - API reference

Response Status Codes

HTTP Status Code Reason

204 Refresh Current Inventory done.

/ManagedDevice/servicemode PUT

Description

Place server and associated service in Service Mode.

Method

put

Response Class

void

Response Content-Type: application/xml, application/json

Parameters

Parameter Value Description Default Value Parameter Type Data Type

body N/A N/A body com.dell.asm.asmc ore.asmmanager.cli ent.deviceinventory .ServiceModeRequ est

Response Status Codes

HTTP Status Code Reason

201 Device has applied Service Mode changes.

400 Invalid Device.

404 Device not found in inventory.

/ManagedDevice/update POST

Description

Update Device in Inventory.

Method

post

Response Class

void

Appendix A - API reference 55

Response Content-Type: application/xml, application/json

Parameters

Parameter Value Description Default Value Parameter Type Data Type

deviceId N/A Device Inventory Ids

N/A query array

Response Status Codes

HTTP Status Code Reason

201 Device Inventory jobs scheduled.

400 Invalid Device.

404 Device not found in inventory.

/ManagedDevice/withcompliance GET

Description

Retrieve all Devices from Inventory with filter.

Method

get

Response Class

[ ManagedDevice ]

Response Content-Type: application/xml, application/json

Parameters

Parameter Value Description Default Value Parameter Type Data Type

sort N/A Sort Column N/A query string

filter N/A Filter Criteria N/A query array

offset N/A Pagination Offset 0 query integer

limit N/A Page Limit 50 query integer

Response Status Codes

HTTP Status Code Reason

200 Devices retrieved from inventory on filter, sort, paginate.

56 Appendix A - API reference

/ManagedDevice/withcompliance/{refId} GET

Description

Retrieve Device from Inventory based on refId.

Method

get

Response Class

ManagedDevice

Response Content-Type: application/xml, application/json

Parameters

Parameter Value Description Default Value Parameter Type Data Type

refId (required) Reference Id N/A path string

Response Status Codes

HTTP Status Code Reason

200 Device retrieved from inventory.

404 Device not found in inventory.

/NTP/ GET

Description

Retrieve NTP settings from virtual appliance.

Method

get

Response Class

ntpSettings

Response Content-Type: application/json, application/xml

Appendix A - API reference 57

Response Status Codes

HTTP Status Code Reason

200 Retrieved NTP settings from virtual appliance successfully.

500 Unable to get NTP settings from the virtual appliance.

/NTP/ PUT

Description

Apply NTP settings on virtual appliance.

Method

put

Response Class

void

Response Content-Type: application/json, application/xml

Parameters

Parameter Value Description Default Value Parameter Type Data Type

body (required) NTPSetting object that needs to be set on virtual appliance

N/A body ntpSettings

Response Status Codes

HTTP Status Code Reason

204 Successfully set the NTP settings to on.

500 Unable to turn on NTP settings on the appliance.

/NTP/ DELETE

Description

Turn off NTP settings on virtual appliance.

58 Appendix A - API reference

Method

delete

Response Class

void

Response Content-Type: application/json, application/xml

Response Status Codes

Table 3. Response Status Codes

HTTP Status Code Reason

204 Successfully set the NTP settings to off.

500 Unable to turn off NTP settings on the appliance.

/Network/ GET

Description

Retrieve networks.

Method

get

Response Class

[ Network ]

Response Content-Type: application/json, application/xml

Parameters

Parameter Value Description Default Value Parameter Type Data Type

sort N/A Valid sort columns are: name,description,ty pe,vlanId,createdBy ,createdDate,updat edBy,updatedDate

N/A query string

filter N/A Valid filter columns are: name,description,ty pe,vlanId,createdBy ,updatedBy,created Date,updatedDate

N/A query array

Appendix A - API reference 59

Parameter Value Description Default Value Parameter Type Data Type

offset N/A Specify pagination offset.

0 query integer

limit N/A Specify page limit. 50 query integer

Response Status Codes

HTTP Status Code Reason

200 Networks retrieved.

400 Problem with a query parameter, check response for details.

404 Networks not found.

/Network/ POST

Description

Add a new network.

Method

post

Response Class

Network

Response Content-Type: application/json, application/xml

Parameters

Parameter Value Description Default Value Parameter Type Data Type

body (required) Network object that needs to be added.

N/A body Network

Response Status Codes

HTTP Status Code Reason

201 Network created.

400 Invalid input or network that is supplied, or other input data is correct.

409 Network already exists.

60 Appendix A - API reference

/Network/{networkId} GET

Description

Find a network by id.

Method

get

Response Class

Network

Response Content-Type: application/json, application/xml

Parameters

Parameter Value Description Default Value Parameter Type Data Type

networkId (required) Id of network to retrieve

N/A path string

Response Status Codes

HTTP Status Code Reason

200 Network retrieved successfully.

404 Network not found.

/Network/{networkId} PUT

Description

Update an existing network.

Method

put

Response Class

void

Response Content-Type: application/xml, application/json

Appendix A - API reference 61

Parameters

Parameter Value Description Default Value Parameter Type Data Type

body (required) Network object that contains update fields.

N/A body Network

networkId (required) Id of network to update

N/A path string

Response Status Codes

HTTP Status Code Reason

204 Network updated successfully.

400 Invalid input for id or network that is supplied, or other input data is incorrect.

404 Network not found.

409 Network with similar name already exists.

/Network/{networkId} DELETE

Description

Delete an existing network.

Method

delete

Response Class

void

Response Content-Type: application/xml, application/json

Parameters

Parameter Value Description Default Value Parameter Type Data Type

networkId (required) Id of network to delete

N/A path string

Response Status Codes

HTTP Status Code Reason

204 Network deleted successfully.

400 Invalid network id supplied.

62 Appendix A - API reference

/Network/{networkId}/usageids GET

Description

Find Usage Ids of network by id.

Method

get

Response Class

UsageIdList

Response Content-Type: application/json, application/xml

Parameters

Parameter Value Description Default Value Parameter Type Data Type

networkId (required) Id of network to retrieve from.

N/A path string

Response Status Codes

HTTP Status Code Reason

200 Network Usage Ids retrieved successfully.

404 Network Usage Ids not found.

/Network/{networkId}/ipaddresses GET

Description

Find IPs of network by id.

Method

get

Response Class

[ IpAddress ]

Response Content-Type: application/json, application/xml

Appendix A - API reference 63

Parameters

Parameter Value Description Default Value Parameter Type Data Type

networkId (required) Id of network to retrieve from.

N/A path string

Response Status Codes

HTTP Status Code Reason

200 Network IPs retrieved successfully.

404 Network IPs not found.

/Network/export/csv GET

Description

Exports all Networks in .csv format.

Method

get

Response Class

void

Response Content-Type: application/octet-stream

Response Status Codes

HTTP Status Code Reason

400 Bad Request, verify that input parameters are correct.

401 No login information specified in the request.

403 User does not have privileges to access this operation.

500 User Log Internal Error, contact your system administrator.

/Network/static GET

Description

Retrieve networks that are static.

64 Appendix A - API reference

Method

get

Response Class

[ Network ]

Response Content-Type: application/xml, application/json

Parameters

None.

Response Status Codes

HTTP Status Code Reason

200 Networks retrieved that are static.

400 Problem with a query parameter, check response for details.

404 Networks not found that are static.

/Network/type/{networkType} GET

Description

Retrieve networks by network type.

Method

get

Response Class

[ Network ]

Response Content-Type: application/json, application/xml

Parameters

Parameter Value Description Default Value Parameter Type Data Type

networkType (required) Specify NetworkType with hyphens instead of underscores.

N/A path string

Appendix A - API reference 65

Response Status Codes

HTTP Status Code Reason

200 Networks retrieved by networkType.

400 Problem with a query parameter, check response for details.

404 Networks not found by networkType.

/OSRepository/ GET

Description

Gets a list of existing operating system repositories.

Method

get

Response Class

OSRepository

Response Content-Type: application/xml, application/json

Response Status Codes

HTTP Status Code Reason

200 All OSRepository objects retrieved.

/OSRepository/ POST

Description

Creates a new OSRepository.

Method

post

Response Class

OSRepository

Response Content-Type: application/xml, application/json

66 Appendix A - API reference

Parameters

Parameter Value Description Default Value Parameter Type Data Type

body N/A N/A body OSRepository

Response Status Codes

HTTP Status Code Reason

201 OSRepository created.

400 Bad Request, verify OSRepository data object is correct.

/OSRepository/{id} GET

Description

Gets the OSRepository by its ID.

Method

get

Response Class

OSRepository

Response Content-Type: application/xml, application/json

Parameters

Parameter Value Description Default Value Parameter Type Data Type

id (required) N/A path string

Response Status Codes

HTTP Status Code Reason

200 OSRepository retrieved.

/OSRepository/{id} PUT

Description

Update OSRepository.

Appendix A - API reference 67

Method

put

Response Class

OSRepository

Response Content-Type: application/xml, application/json

Parameters

Parameter Value Description Default Value Parameter Type Data Type

body N/A N/A body OSRepository

id (required) N/A path string

sync N/A Sync ISO false query boolean

Response Status Codes

HTTP Status Code Reason

204 OSRepository updated.

400 Invalid Parameters to update OSRepository or problem with the Resource Adapters.

404 OSRepository not found.

/OSRepository/{id} DELETE

Description

Deletes an existing OSRepository.

Method

delete

Response Class

OSRepository

Response Content-Type: application/xml, application/json

Parameters

Parameter Value Description Default Value Parameter Type Data Type

id (required) N/A path string

68 Appendix A - API reference

Response Status Codes

HTTP Status Code Reason

200 Successfully deleted OSRepository.

400 Bad Request, verify that id is correct.

404 Bad Request, verify that id is correct.

/OSRepository/connection POST

Description

Tests the connection to a remote path.

Method

post

Response Class

OSRepository

Response Content-Type: application/xml, application/json

Parameters

Parameter Value Description Default Value Parameter Type Data Type

body N/A N/A body OSRepository

Response Status Codes

HTTP Status Code Reason

201 Connection to remote path successful.

/OSRepository/sync/{id} PUT

Description

Syncs the OSRepository by its ID.

Method

put

Appendix A - API reference 69

Response Class

OSRepository

Response Content-Type: application/xml, application/json

Parameters

Parameter Value Description Default Value Parameter Type Data Type

body N/A osRepo N/A body OSRepository

id (required) N/A path string

Response Status Codes

Table 4. Response Status Codes

HTTP Status Code Reason

200 OSRepository Sync

/Proxy/ GET

Description

Retrieve proxy settings from virtual appliance.

Method

get

Response Class

proxySettings

Response Content-Type: application/json, application/xml

Response Status Codes

HTTP Status Code Reason

200 Virtual appliance proxy settings retrieved successfully.

500 Unable to retrieve proxy settings from virtual appliance.

70 Appendix A - API reference

/Proxy/ PUT

Description

Set the proxy settings on virtual appliance.

Method

put

Response Class

proxySettings

Response Content-Type: application/json, application/xml

Parameters

Parameter Value Description Default Value Parameter Type Data Type

body (required) ProxySetting object that needs to be set on virtual appliance.

N/A body proxySettings

Response Status Codes

HTTP Status Code Reason

200 Proxy settings set successfully on virtual appliance.

500 Unable to set the proxy settings on virtual appliance.

/Proxy/test POST

Description

Retrieve proxy settings from virtual appliance.

Method

post

Response Class

testProxyResponse

Response Content-Type: application/json, application/xml

Appendix A - API reference 71

Parameters

Parameter Value Description Default Value Parameter Type Data Type

body (required) ProxySetting object that needs to be tested on virtual appliance.

N/A body proxySettings

Response Status Codes

HTTP Status Code Reason

200 Passed test for proxy settings defined on virtual appliance.

500 Unable to test proxy settings defined on virtual appliance.

/Server/ GET

Description

Gets a list of servers.

Method

get

Response Class

[ Server ]

Response Content-Type: application/xml, application/json

Parameters

Parameter Value Description Default Value Parameter Type Data Type

sort N/A Valid sort columns: health,management IP,serviceTag,powe rState,credentialId

N/A query string

filter N/A Valid filter columns: health,management IP,serviceTag,powe rState,credentialId

N/A query array

offset N/A Specify pagination offset.

0 query integer

limit N/A Specify page limit. 50 query integer

72 Appendix A - API reference

Response Status Codes

HTTP Status Code Reason

200 Retrieved.

400 Bad Request, verify that input parameters are correct.

401 No login information specified in the request.

403 User does not have privileges to access this operation.

500 Server Internal Error, contact your system administrator.

/Server/{refId} GET

Description

Retrieves an individual Server.

Method

get

Response Class

Server

Response Content-Type: application/xml, application/json

Parameters

Parameter Value Description Default Value Parameter Type Data Type

refId (required) Reference id of server

N/A path string

Response Status Codes

HTTP Status Code Reason

200 Retrieved.

400 Bad Request, verify refId is correct.

401 No login information specified in the request.

403 User does not have privileges to access this operation.

404 Server not found.

500 Server Internal Error, contact your system administrator.

Appendix A - API reference 73

/Server/{refId} DELETE

Description

Removes a Server.

Method

delete

Response Class

void

Response Content-Type: application/xml, application/json

Parameters

Parameter Value Description Default Value Parameter Type Data Type

refId (required) Reference id of server

N/A path string

Response Status Codes

HTTP Status Code Reason

204 Deleted.

400 Bad Request, verify refId is correct.

401 No login information specified in the request.

403 User does not have privileges to access this operation.

500 Server Internal Error, contact your system administrator.

/Server/count GET

Description

Gets a count of servers.

Method

get

Response Class

integer

74 Appendix A - API reference

Response Content-Type: text/plain

Parameters

Parameter Value Description Default Value Parameter Type Data Type

filter N/A Valid filter columns: health,management IP,serviceTag,powe rState,credentialId

N/A query array

Response Status Codes

HTTP Status Code Reason

200 Retrieved.

400 Bad Request, verify that input parameters are correct.

401 No login information specified in the request.

403 User does not have privileges to access this operation.

500 Server Internal Error, contact your system administrator.

/Server/serviceTag/{serviceTag} GET

Description

Retrieves an individual Server with serviceTag.

Method

get

Response Class

Server

Response Content-Type: application/xml, application/json

Parameters

Parameter Value Description Default Value Parameter Type Data Type

serviceTag (required) serviceTag of the server

N/A path string

Response Status Codes

HTTP Status Code Reason

200 Retrieved.

Appendix A - API reference 75

HTTP Status Code Reason

400 Bad Request, verify refId is correct.

401 No login information specified in the request.

403 User does not have privileges to access this operation.

404 Server not found.

500 Server Internal Error, contact your system administrator.

/ServiceTemplate/ GET

Description

Retrieve all ServiceTemplates with filter, sort, paginate which returns Array of ServiceTemplate.class.

Method

get

Response Class

[ ServiceTemplate ]

Response Content-Type: application/xml, application/json

Parameters

Parameter Value Description Default Value Parameter Type Data Type

sort N/A Supported sort columns are: name,createdBy,cr eatedDate,updated By,updatedDate

N/A query string

filter N/A Supported filter columns are: name,draft,created By,updatedBy,creat edDate,updatedDat e

N/A query array

offset N/A Pagination Offset 0 query integer

limit N/A Page Limit 50 query integer

full N/A Full or Brief false query boolean

includeAttachment s

N/A Include Attachments.

true query boolean

76 Appendix A - API reference

Response Status Codes

HTTP Status Code Reason

200 All ServiceTemplates retrieved on filter, sort, paginate.

/ServiceTemplate/ POST

Description

Create new ServiceTemplate.

Method

post

Response Class

ServiceTemplate

Response Content-Type: application/xml, application/json

Parameters

Parameter Value Description Default Value Parameter Type Data Type

body N/A Infrastructure Template to create.

N/A body ServiceTemplate

Response Status Codes

HTTP Status Code Reason

201 ServiceTemplate created.

400 Invalid parameters to create ServiceTemplate or problems with the Resource Adapters.

409 Template already exists.

/ServiceTemplate/{id} GET

Description

Retrieve ServiceTemplate based on ServiceTemplate id.

Method

get

Appendix A - API reference 77

Response Class

ServiceTemplate

Response Content-Type: application/xml, application/json

Parameters

Parameter Value Description Default Value Parameter Type Data Type

id (required) Infrastructure Template Id (String)

N/A path string

forDeployment N/A Will return expanded version of template prepared for deployment wizard

false query boolean

includeBrownfieldVmMang ers

N/A Will return Managed and Reserved VM Managers if set to true, other wise only returns Discovered.

false query boolean

Response Status Codes

HTTP Status Code Reason

200 ServiceTemplate retrieved.

404 ServiceTemplate not found.

/ServiceTemplate/{id} PUT

Description

Update Template.

Method

put

Response Class

ServiceTemplate

Response Content-Type: application/xml, application/json

78 Appendix A - API reference

Parameters

Parameter Value Description Default Value Parameter Type Data Type

body N/A Infrastructure Template to update.

N/A body ServiceTemplate

id (required) Infrastructure Template Id (String)

N/A path string

Response Status Codes

HTTP Status Code Reason

204 Infrastructure Template updated.

400 Invalid parameters to update ServiceTemplate.

404 Template not found.

/ServiceTemplate/{id} DELETE

Description

Delete ServiceTemplate -- this operation is idempotent.

Method

delete

Response Class

void

Response Content-Type: application/xml, application/json

Parameters

Parameter Value Description Default Value Parameter Type Data Type

id (required) Infrastructure Template Id (String)

N/A path string

Response Status Codes

HTTP Status Code Reason

204 ServiceTemplate deleted.

500 Unable to delete ServiceTemplate.

Appendix A - API reference 79

/ServiceTemplate/{id}/copy POST

Description

Copy a ServiceTemplate.

Method

post

Response Class

ServiceTemplate

Response Content-Type: application/xml, application/json

Parameters

Parameter Value Description Default Value Parameter Type Data Type

body N/A Infrastructure Template settings

N/A body ServiceTemplate

id (required) Infrastructure Template Id (String)

N/A path string

Response Status Codes

HTTP Status Code Reason

201 ServiceTemplate copied successfully.

400 Invalid Parameters to copy ServiceTemplate or problems with the Resource Adapters.

409 Template already exists.

/ServiceTemplate/{id}/mapToPhysicalResources POST

Description

Do Physical Resource allocation based on ServiceTemplate.

Method

post

80 Appendix A - API reference

Response Class

ServiceTemplate

Response Content-Type: application/xml, application/json

Parameters

Parameter Value Description Default Value Parameter Type Data Type

id (required) Infrastructure Template Id (String)

N/A path string

Response Status Codes

HTTP Status Code Reason

201 Map Service Template to physical resources.

400 Invalid Parameters to copy ServiceTemplate or problems with the Resource Adapters.

409 Template already exists.

/ServiceTemplate/cloneTemplate POST

Description

Create new ServiceTemplate from passed in ServiceTemplate.

Method

post

Response Class

ServiceTemplate

Response Content-Type: application/xml, application/json

Parameters

Parameter Value Description Default Value Parameter Type Data Type

body N/A Service Template to clone.

N/A body ServiceTemplate

Appendix A - API reference 81

Response Status Codes

HTTP Status Code Reason

201 ServiceTemplate created.

400 Invalid Parameters to create ServiceTemplate.

409 Template already exists.

/ServiceTemplate/components/service/{serviceId} PUT

Description

Update Template by analyzing related components.

Method

put

Response Class

ServiceTemplate

Response Content-Type: application/xml, application/json

Parameters

Parameter Value Description Default Value Parameter Type Data Type

body N/A Template to update N/A body ServiceTemplate

serviceId (required) Service Id N/A path string

Response Status Codes

HTTP Status Code Reason

200 ServiceTemplate updated.

404 ServiceTemplate not found.

/ServiceTemplate/components/template/ {templateId} PUT

Description

Update Template by analyzing related components.

82 Appendix A - API reference

Method

put

Response Class

ServiceTemplate

Response Content-Type: application/xml, application/json

Parameters

Parameter Value Description Default Value Parameter Type Data Type

body N/A Template to update N/A body ServiceTemplate

templateId (required) Template Id N/A path string

Response Status Codes

HTTP Status Code Reason

200 ServiceTemplate updated.

404 ServiceTemplate not found.

/ServiceTemplate/device/{deviceId} GET

Description

Retrieve Default Template customized for specified device.

Method

get

Response Class

ServiceTemplate

Response Content-Type: application/xml, application/json

Parameters

Parameter Value Description Default Value Parameter Type Data Type

deviceId (required) Device Id (String) N/A path string

Appendix A - API reference 83

Response Status Codes

HTTP Status Code Reason

200 ServiceTemplate retrieved.

404 ServiceTemplate not found.

/ServiceTemplate/export/csv GET

Description

Exports all Templates in .csv format.

Method

get

Response Class

void

Response Content-Type: application/octet-stream

Response Status Codes

HTTP Status Code Reason

400 Bad Request, verify that input parameters are correct.

401 No login information specified in the request.

403 User does not have privileges to access this operation.

500 User Log Internal Error, contact your system administrator.

/ServiceTemplate/service/{serviceId}/ {componentType} GET

Description

Retrieve Default Template with components refined for specified template ID.

Method

get

84 Appendix A - API reference

Response Class

ServiceTemplate

Response Content-Type: application/xml, application/json

Parameters

Parameter Value Description Default Value Parameter Type Data Type

serviceId (required) Service Id (String) N/A path string

componentType (required) Template Component Type (String)

N/A path string

Response Status Codes

HTTP Status Code Reason

200 ServiceTemplate retrieved.

404 ServiceTemplate not found.

/ServiceTemplate/template/{templateId}/ {componentType} GET

Description

Retrieve Default Template with components refined for specified template ID.

Method

get

Response Class

ServiceTemplate

Response Content-Type: application/xml, application/json

Parameters

Parameter Value Description Default Value Parameter Type Data Type

templateId (required) Template Id (String)

N/A path string

componentType (required) Template Component Type (String)

N/A path string

Appendix A - API reference 85

Response Status Codes

HTTP Status Code Reason

200 ServiceTemplate retrieved.

404 ServiceTemplate not found.

/ServiceTemplate/updateParameters POST

Description

Create a new ServiceTemplate.

Method

post

Response Class

ServiceTemplate

Response Content-Type: application/xml, application/json

Parameters

Parameter Value Description Default Value Parameter Type Data Type

body N/A Fills in any missing parameters that are required to deploy the template.

N/A body ServiceTemplate

Response Status Codes

HTTP Status Code Reason

200 Parameters updated.

/ServiceTemplate/upload POST

Description

Upload a ServiceTemplate.

Method

post

86 Appendix A - API reference

Response Class

ServiceTemplate

Response Content-Type: application/xml, application/json

Parameters

Parameter Value Description Default Value Parameter Type Data Type

body N/A Service Template upload request

N/A body ServiceTemplateUp loadRequest

Response Status Codes

HTTP Status Code Reason

201 ServiceTemplate uploaded successfully.

400 Invalid parameters to upload template.

/ServiceTemplate/users DELETE

Description

Delete Users from Templates.

Method

delete

Response Class

void

Response Content-Type: application/xml, application/json

Parameters

Parameter Value Description Default Value Parameter Type Data Type

userId N/A Valid UserIds N/A query array

Response Status Codes

HTTP Status Code Reason

204 Users deleted from Templates.

500 Unable to delete User from Templates.

Appendix A - API reference 87

/Timezone/ GET

Description

Retrieve virtual appliance time zone.

Method

get

Response Class

timeZone

Response Content-Type: application/json, application/xml

Response Status Codes

HTTP Status Code Reason

200 Virtual appliance time zone retrieved successfully.

500 Unable to retrieve virtual appliance time zone.

/Timezone/ PUT

Description

Sets the virtual appliance time zone.

Method

put

Response Class

Response

Response Content-Type: application/json, application/xml

Parameters

Parameter Value Description Default Value Parameter Type Data Type

body (required) TimeZoneInfo that needs to be set on virtual appliance.

N/A body timeZone

88 Appendix A - API reference

Response Status Codes

HTTP Status Code Reason

200 Virtual appliance time zone set successfully.

500 Unable to set the virtual appliance time zone.

/Timezone/all GET

Description

Retrieve list of available time zones.

Method

get

Response Class

availableTimeZones

Response Content-Type: application/json, application/xml

Parameters

Parameter Value Description Default Value Parameter Type Data Type

offset N/A Specify pagination offset.

N/A query integer

limit N/A Specify page limit, cannot exceed system maximum limit.

N/A query integer

Response Status Codes

HTTP Status Code Reason

200 Available time zones list retrieved successfully.

500 Unable to retrieve list of available time zones.

/TroubleshootingBundle/export POST

Description

Sends the troubleshooting bundle to the defined destination. This can be performed by Admin or Read-only users.

Appendix A - API reference 89

Method

post

Parameters

Parameter Value Description Default Value Parameter Type Data Type

body (required) Troubleshooting bundle to send to the defined destination

N/A body TroubleshootingBu ndleParams

Response Status Codes

HTTP Status Code Reason

200 Good request

400 Invalid parameter values

401 Login information not specified

401 Forbidden (user does not have privileges)

500 Internal server error

/TroubleshootingBundle/test POST

Description

Tests the connection to the destination for the troubleshooting bundle. This can be performed by Admin or Read-only users.

Method

post

Parameters

Parameter Value Description Default Value Parameter Type Data Type

body (required) Troubleshooting bundle to use for testing the connection

N/A body TroubleshootingBu ndleParams

Response Status Codes

HTTP Status Code Reason

200 Good request

400 Invalid parameter values

401 Login information not specified

90 Appendix A - API reference

HTTP Status Code Reason

401 Forbidden (user does not have privileges)

500 Internal server error

/User/ GET

Description

Retrieve a list of Users.

Method

get

Response Class

[ User ]

Response Content-Type: application/json, application/xml

Parameters

Parameter Value Description Default Value Parameter Type Data Type

filter N/A Valid filter columns: userName,domainN ame,firstName,last Name,enabled,syst emUser,email,phon eNumber,role,creat edDate,createdBy,u pdatedDate,update dBy

N/A query array

offset N/A Specify pagination offset.

0 query integer

limit N/A Specify page limit. 50 query integer

sort N/A Valid sort columns: userName,domainN ame,firstName,last Name,enabled,emai l,phoneNumber,role ,createdDate,creat edBy,updatedDate, updatedBy

N/A query string

Response Status Codes

HTTP Status Code Reason

200 OK

Appendix A - API reference 91

/User/ POST

Description

Add a new user.

Method

post

Response Class

User

Response Content-Type: application/json, application/xml

Parameters

Parameter Value Description Default Value Parameter Type Data Type

body (required) User object to add. N/A body User

Response Status Codes

Table 5. Response Status Codes

HTTP Status Code Reason

201 User created.

400 Invalid input.

409 User already exists.

/User/{userId} GET

Description

Find a user by Id.

Method

get

Response Class

User

Response Content-Type: application/json, application/xml

92 Appendix A - API reference

Parameters

Parameter Value Description Default Value Parameter Type Data Type

userId (required) Id of user to retrieve

N/A path integer

Response Status Codes

HTTP Status Code Reason

200 OK.

404 User not found.

/User/{userId} PUT

Description

Update an existing user.

Method

put

Response Class

User

Response Content-Type: application/json, application/xml

Parameters

Parameter Value Description Default Value Parameter Type Data Type

body (required) User object that contains update fields.

N/A body User

userId (required) ID of user to update

N/A path integer

Response Status Codes

HTTP Status Code Reason

204 Update completed successfully.

400 Problem with the update data, check error response for details.

404 User not found.

Appendix A - API reference 93

/User/{userId} DELETE

Description

Delete an existing user.

Method

delete

Response Class

void

Response Content-Type: application/xml, application/json

Parameters

Parameter Value Description Default Value Parameter Type Data Type

userId (required) Id of user to delete N/A path integer

Response Status Codes

HTTP Status Code Reason

204 Delete completed successfully.

404 User not found.

/WizardStatus/ GET

Description

Retrieve virtual appliance Setup Status.

Method

get

Response Class

wizardStatus

Response Content-Type: application/json, application/xml

94 Appendix A - API reference

Response Status Codes

HTTP Status Code Reason

204 Initial Wizard Status retrieved successfully.

500 Get Initial Wizard Status operation failed.

/WizardStatus/ PUT

Description

Set the virtual appliance Setup Status.

Method

put

Response Class

wizardStatus

Response Content-Type: application/json, application/xml

Parameters

Parameter Value Description Default Value Parameter Type Data Type

body (required) Initial Wizard status that needs to be set in ALCM.

N/A body wizardStatus

Response Status Codes

HTTP Status Code Reason

204 Initial Wizard Status updated successfully.

400 Request parameter is invalid.

500 Update Initial Wizard Status operation failed.

Appendix A - API reference 95

Appendix B - Model reference

asmCredential Name: asmCredential

CAUTION: For the /Credential/ POST and /Credential/{id} PUT APIs, XML is required for request payloads.

Property Name Property Type Required

credential credential true

references references false

link Link false

The credential property must be constructed as a tag indicating the type of credential. The tag to use depends on the resource:

For a node, use serverCredential For a switch, use iomCredential For a vCenter, use vCenterCredential For an Element Manager, use emCredential For a PowerFlex Gateway, use scaleIOCredential For a presentation server, use PSCredential For an operating system administrator, use OSCredential For an operating system user, use OSUserCredential

Here are some sample POST payloads that show the use of these tags:

root P@ssw0rd

root calvin

AsmDetailedMessage Name: AsmDetailedMessage

Property Name Property Type Required

timeStamp string false

10

96 Appendix B - Model reference

Property Name Property Type Required

messageBundle string false

severity string false

sequenceNumber integer false

category string false

displayMessage string false

messageCode string false

correlationId string false

agentId string false

responseAction string false

detailedMessage string false

AsmDetailedMessageList Name: AsmDetailedMessageList

Property Name Property Type Required

messages AsmDetailedMessage false

AuthenticateRequest Name: AuthenticateRequest

Property Name Property Type Required

userName string false

domain string false

password string false

AuthenticateResponse Name: AuthenticateResponse

Property Name Property Type Required

userName string true

apiSecret string true

domain string true

role string true

apiKey string true

availableTimeZones Name: availableTimeZones

Appendix B - Model reference 97

Property Name Property Type Required

availableTimeZones timeZone false

BrownfieldStatus Enum: BrownfieldStatus

Property Name

Property Type

values ["NEWLY_AVAILABLE", "NOT_APPLICABLE", "UNAVAILABLE_RELATED_SERVER_NOT_IN_INVENTORY", "UNAVAILABLE_RELATED_SERVER_IN_EXISTING_SERVICE", "UNAVAILABLE_RELATED_SERVER_NOT_MANAGED_OR_RESERVED", "UNAVAILABLE_NOT_IN_INVENTORY", "UNAVAILABLE_NOT_MANAGED_OR_RESERVED", "UNAVAILABLE_IN_EXISTING_SERVICE", "UNAVAILABLE_THIS_DEVICE_AND_RELATED_SERVER_NOT_IN_INVENTORY", "UNAVAILABLE_THIS_DEVICE_AND_RELATED_SERVER_NOT_MANAGED_OR_RESERVED", "UNAVAILABLE_THIS_DEVICE_NOT_MANAGED_OR_RESERVED_AND_RELATED_SERVER_NOT_IN_INVEN TORY", "UNAVAILABLE_THIS_DEVICE_NOT_MANAGED_OR_RESERVED_AND_RELATED_SERVER_IN_EXISTING_S ERVICE", "UNAVAILABLE_THIS_DEVICE_NOT_IN_INVENTORY_AND_RELATED_SERVER_NOT_MANAGED_OR_RESE RVED", "UNAVAILABLE_THIS_DEVICE_NOT_IN_INVENTORY_AND_RELATED_SERVER_IN_EXISTING_SERVICE", "AVAILABLE", "CURRENTLY_DEPLOYED_IN_BROWNFIELD, UNAVAILABLE_REMOVED_FROM_SERVICE, LIFECYCLE_MODE"]

ComparatorValue Enum: ComparatorValue

Property Name Property Type

values ["minimum," "maximum," "exact"]

CompliantState Enum: CompliantState

Property Name Property Type

values [NA, "COMPLIANT", "NONCOMPLIANT", "UNKNOWN", UPDATEREQUIRED]

component Name: component

Property Name Property Type Required

refId string false

manageFirmware boolean false

asmGUID string false

teardown boolean false

98 Appendix B - Model reference

Property Name Property Type Required

componentID string false

brownfield boolean false

helpText string false

componentValid ServiceTemplateValid false

cloned boolean false

subType ServiceTemplateComponentSubType false

puppetCertName string false

associatedComponents Map > false

clonedFromId string false

relatedComponents Map false

iP string false

serialNumber string false

configFile string false

name string false

resources ServiceTemplateCategory false

id string false

type SrviceTemplateComponentType false

connected_switch Name: connected_switch

Property Name Property Type Required

localDevice string false

localPorts [string] false

remoteDeviceType string false

remoteDevice string false

localDeviceType string false

remotePorts [string] false

Controller Name: Controller

Property Name Property Type Required

enclosures Enclosure false

fqdd string false

virtualDisks VirtualDisk false

physicalDisks PhysicalDisk false

numPhysDisks integer false

Appendix B - Model reference 99

Property Name Property Type Required

id string false

credential Name: credential

Property Name Property Type Required

createdDate string false

updatedBy string false

updatedDate string false

label string true

domain string false

link Link false

username string true

createdBy string false

password string false

id string false

credentialList Name: credentialList

Property Name Property Type Required

totalRecords integer false

credentialList asmCredential false

Deployment Name: Deployment

Property Name Property Type Required

createdDate GregorianCalendar false

updatedBy string false

updatedDate GregorianCalendar false

firmwareRepository FirmwareRespository false

assignedUsers User false

allUsersAllowed boolean false

teardown boolean false

templateValid boolean false

brownfield boolean false

vDS boolean false

100 Appendix B - Model reference

Property Name Property Type Required

deploymentHealthStatusType DeploymentHealthStatusType false

canMigrate boolean false

scheduleDate string false

numberOfDeployments integer false

firmwareRepositoryId string false

canScaleupStorage boolean false

canScaleupNetwork boolean false

canScaleupServer boolean false

canScaleupVM boolean false

canDeleteResources boolean false

canRetry boolean false

canEdit boolean false

canDelete boolean false

canCancel boolean false

canScaleupApplication boolean false

canScaleupCluster boolean false

deploymentName string false

deploymentDescription string false

serviceTemplate ServiceTemplate false

deploymentDevice DeploymentDevice false

vms VM false

jobDetails logEntry false

retry boolean false

updateServerFirmware boolean false

individualTeardown boolean false

overallDeviceHealth DeviceHealth false

compliant boolean false

createdBy string false

status DeploymentStatusType false

id string false

owner string false

DeploymentDevice Name: DeploymentDevice

Property Name Property Type Required

refId string false

deviceType DeviceType false

Appendix B - Model reference 101

Property Name Property Type Required

serviceTag string false

ipAddress string false

statusMessage string false

healthMessage string false

brownfield boolean false

componentId string false

brownfieldStatus BrownfieldStatus false

deviceHealth DeviceHealth false

compliantState CompliantState false

statusEndTime string false

statusStartTime string false

logDump string false

status DeploymentStatusType false

refType string false

DeploymentFilterResponse Name: DeploymentFilterResponse

Property Name Property Type Required

numberRequestedServers integer false

numberSelectedServers integer false

failedPoolId string false

failedPoolName string false

selectedServers SelectedServer false

rejectedServers RejectedServer false

DeploymentHealthStatusType Enum: DeploymentHealthStatusType

Property Name Property Type

values [GREEN, YELLOW, RED, CANCELLED]

DeploymentStatusType Enum: DeploymentStatusType

Property Name Property Type

values ["PENDING", "IN_PROGRESS", "COMPLETE", "INCOMPLETE", "LIFECYCLE_MODE", "ERROR", "CANCELLED", "CANCELLING",

102 Appendix B - Model reference

Property Name Property Type

"FIRMWARE_UPDATING", "POST_DEPLOYMENT_SOFTWARE_UPDATING", "SERVICE_MODE"]

DeviceDiscoveryRequest Name: DeviceDiscoveryRequest

Property Name Property Type Required

deviceType DeviceType false

deviceStartIp string false

deviceServerCredRef string false

deviceChassisCredRef string false

deviceSwitchCredRef string false

deviceSCVMMCredRef string false

deviceStorageCredRef string false

deviceVCenterCredRef string false

deviceEMCredRef string false

unmanaged boolean false

reserved boolean false

serverPoolId string false

config string false

deviceBMCServerCredRef string false

deviceEndIp string false

DeviceDiscoveryRequests Name: DeviceDiscoveryRequests

Property Name Property Type Required

discoverIpRangeDeviceRequest NOTE: For JSON, this property begins with a capital letter (DiscoverIpRangeDeviceRequest).

DeviceDiscoveryRequest false

DeviceGroup Name: DeviceGroup

Property Name Property Type Required

createdDate GregorianCalendar false

updatedBy string false

updatedDate GregorianCalendar false

Appendix B - Model reference 103

Property Name Property Type Required

groupDescription string false

managedDeviceList ManagedDeviceList false

groupUserList GroupUserList false

groupSeqId integer false

groupName string true

link Link false

createdBy string false

DeviceGroupList Name: DeviceGroupList

Property Name Property Type Required

deviceGroup DeviceGroup true

totalCount integer false

DeviceHealth Enum: DeviceHealth

Property Name Property Type

values [GREEN, YELLOW, RED, SERVICE_MODE, UNKNOWN]

DeviceState Enum: DeviceState

Property Name Property Type

values ["READY", "UPDATING", "UPDATE_FAILED", "CONFIGURATION_ERROR", "PENDING_CONFIGURATION_TEMPLATE", "PENDING_DELETE", "PENDING_SERVICE_MODE", "PENDING", "DISCOVERY_FAILED", "DEPLOYMENT_ERROR", "DELETE_FAILED", "DELETED", "DEPLOYED", "DEPLOYING", "CANCELLED", "SERVICE_MODE"]

DeviceType Enum: DeviceType

Property Name Property Type

values ["RackServer", "em", "ome", "ipicabinet", "clc", "dellswitch", "ciscoswitch", "dellswitchos10", "vcenter", "scaleio"]

deprecated ["Server", "BladeServer", "bmc", "FXServer", "TowerServer", "storage", "TOR", "AggregatorIOM", "MXLIOM", "genericswitch", "vm", "scvmm", "rhvm", "unknown"]

104 Appendix B - Model reference

dhcpSettings Name: dhcpSettings

Property Name Property Type Required

subnet string false

netmask string false

startingIpAddress string false

endingIpAddress string false

defaultLeaseTime integer false

maxLeaseTime integer false

gateway string false

dns string false

enabled boolean false

domain string false

DiscoverDeviceType Enum: DiscoverDeviceType

Property Name Property Type

values ["IDRAC7", "IDRAC8", "IDRAC9","VCENTER", "FORCE10", "FORCE10_S4810", "FORCE10_S5000", "FORCE10_S6000", "FORCE10_S4048", "FORCE10IOM", "FX2_IOM", "DELL_IOM_84", "CISCONEXUS", "SCALEIO", "OME", "IPI", "RHVM", "CLC", "DELLSWITCHOS10"]

deprecated ["CMC", "CMC_FX2", "UNKNOWN" , "SERVER", "VRTX", "FX2_IOM", "BROCADE", "POWERCONNECT", "POWERCONNECT_N3000", "POWERCONNECT_N4000", "SCVMM", "BMC", "EM"]

DiscoveredDevices Name: DiscoveredDevices

Property Name Property Type Required

refId string true

deviceType DeviceType false

serviceTag string true

ipAddress string true

iomCount integer false

serverCount integer false

model string false

healthStatusMessage string false

serverType string false

credId string true

Appendix B - Model reference 105

Property Name Property Type Required

discoverDeviceType DiscoverDeviceType false

chassisId string false

firmwareDeviceInventories FirmwareDeviceInventory false

facts string false

statusMessage string false

deviceRefId string true

healthState string false

parentJobId string true

unmanaged boolean false

reserved boolean false

serverPoolId string false

systemId string false

config string false

jobId string false

configuration string false

status DiscoveryStatus false

refType string true

vendor string false

displayName string false

DiscoveryRequest Name: DiscoveryRequest

Property Name Property Type Required

devices DiscoveredDevices false

statusMessage string false

totalCount integer false

discoveryRequestList DeviceDiscoveryRequests false

link Link false

status DiscoveryStatus false

id string true

DiscoveryResult Name: DiscoveryResult

Property Name Property Type Required

refId string false

deviceType DeviceType false

106 Appendix B - Model reference

Property Name Property Type Required

serviceTag string false

ipAddress string false

iomCount integer false

serverCount integer false

model string false

serverType string false

discoverDeviceType DiscoverDeviceType false

firmwareDeviceInventories FirmwareDeviceInventory false

statusMessage string false

deviceRefId string false

healthState string false

healthStatusMsg string false

parentJobId string false

systemId string false

config string false

jobId string false

status DiscoveryStatus false

refType string false

vendor string false

DiscoveryStatus Enum: DiscoveryStatus

Property Name Property Type

values [PENDING, CONNECTED, UNSUPPORTED, INPROGRESS, SUCCESS, FAILED, ERROR, IGNORE]

DiskMediaType Enum: DiskMediaType

Property Name Property Type

values ["requiressd", "requirehdd", "requirenvme", "first", "last", "any"]

emailServerConfig Name: emailServerConfig

Property Name Property Type Required

emailServerType string false

Appendix B - Model reference 107

Property Name Property Type Required

emailServerIp string false

emailServerPort string false

emailSenderAddress string false

emailUserName string false

emailPassword string false

emailRecipientAddress_1 string false

emailRecipientAddress_2 string false

emailRecipientAddress_3 string false

emailRecipientAddress_4 string false

emailRecipientAddress_5 string false

credentialId string false

Enclosure Name: Enclosure

Property Name Property Type Required

fqdd string false

productName string false

id string false

Fabric Name: Fabric

Property Name Property Type Required

maxPartitions integer false

partitioned boolean false

nictype string false

redundancy boolean false

fabrictype string false

usedforfc boolean false

nPorts integer false

nictypeSource string false

enabled boolean false

name string false

interfaces Interface false

id string false

108 Appendix B - Model reference

fc_interface Name: fc_interface

Property Name Property Type Required

fqdd string false

wwpn string false

activeZoneset string false

connectedZones [string] false

connectedSwitch string false

FirmwareComplianceComponents Name: FirmwareComplianceComponents

Property Name Property Type Required

embeddedRepoComponents SoftwareComponent false

defaultRepoComponents SoftwareComponent false

compliantState CompliantState false

FirmwareComplianceReport Name: FirmwareComplianceReport

Property Name Property Type Required

serviceTag String false

ipAddress String false

firmwareRepositoryName String false

FirmwareComplianceReportComponents List false

isCompliant boolean false

deviceType DeviceType false

model String false

available boolean false

managedState ManagedState false

embededRepo boolean false

deviceState DeviceState false

Appendix B - Model reference 109

FirmwareDeviceInventory Name: FirmwareDeviceInventory

Property Name Property Type Required

deviceInventory ManagedDevice false

discoveryResult DiscoveryResult false

fqdd string false

componentID string false

deviceID string false

vendorID string false

subdeviceID string false

subvendorID string false

ipaddress string false

firmwareComplianceComponents FirmwareComplianceComponents false

servicetag string false

parent_job_id string false

version string false

systemId string false

jobId string false

lastUpdateTime string false

componentType string false

name string false

id string false

FirmwareInventory Name: FirmwareInventory

Property Name Property Type Required

deviceRef string false

firmwareId string false

fqdd string false

componentID string false

deviceID string false

vendorID string false

subdeviceID string false

subvendorID string false

bPresent boolean false

updateable boolean false

version string false

110 Appendix B - Model reference

Property Name Property Type Required

lastUpdateTime string false

componentType string false

name string false

FirmwareRepository Name: FirmwareRepository

Property Name Property Type Required

createdDate string false

updatedBy string false

updatedDate string false

softwareComponents SoftwareComponent false

sourceLocation string false

sourceType string false

diskLocation string false

md5Hash string false

downloadStatus RepositoryStatus false

softwareBundles SoftwareBundle false

bundleCount integer false

defaultCatalog boolean false

componentCount integer false

deployments Deployment false

username string false

createdBy string false

filename string false

password string false

embedded boolean false

name string false

id string false

state RepositoryState false

FirmwareUpdateRequest

Name: FirmwareUpdateRequest

Property Name Property Type Required

updateType UpdateType false

idList [string] false

scheduleType string false

Appendix B - Model reference 111

Property Name Property Type Required

exitMaintenanceMode boolean false

scheduleDate string false

GregorianCalendar

Name: GregorianCalendar

Property Name Property Type Required

weekDateSupported boolean false

weekYear integer false

weeksInWeekYear integer false

gregorianChange string false

timeZone timeZone false

lenient boolean false

firstDayOfWeek integer false

minimalDaysInFirstWeek integer false

timeInMillis integer false

time string false

GroupUser Name: GroupUser

Property Name Property Type Required

userName string false

userSeqId integer true

firstName string false

lastName string false

enabled boolean false

role string true

GroupUserList Name: GroupUserList

Property Name Property Type Required

totalRecords integer false

groupUsers GroupUser false

112 Appendix B - Model reference

Health Enum: Health

Property Name Property Type

values ["GREEN", "YELLOW", "RED", "UNKNOWN"]

HotSpareStatus Enum: HotSpareStatus

Property Name Property Type

values ["No", "Dedicated", "Global"]

IdentityType Enum: IdentityType

Property Name Property Type

values ["UNKNOWN", "WWPN", "WWNN", "ISCSI_MAC", "FIPS_MAC", "LAN_MAC", "IQN_INITIATOR", "IP_INITIATOR", "BOOTLUN", "IQN_TARGET", "IP_TARGET", "WWPN_TARGET"]

IKVM Name: IKVM

Property Name Property Type Required

present boolean false

manufacturer string false

partNumber string false

firmwareVersion string false

name string false

id string false

Interface Name: Interface

Property Name Property Type Required

fqdd string false

maxPartitions integer false

partitioned boolean false

partitions Partition false

nictype string false

Appendix B - Model reference 113

Property Name Property Type Required

redundancy boolean false

enabled boolean false

name string false

id string false

IpAddress Name: IpAddress

Property Name Property Type Required

ipRangeId string false

iPAsLong integer false

iPAddress string false

usageId string true

id string false

state string true

IpRange Name: IpRange

Property Name Property Type Required

startingIp string true

endingIp string true

id string false

Link Name: Link

Property Name Property Type Required

rel string true

href string true

title string false

type string false

List Name: List

Property Name Property Type Required

empty boolean false

114 Appendix B - Model reference

LocalizedLogMessage Name: LocalizedLogMessage

Property Name Property Type Required

logId integer false

messageCode string false

bundleName string false

category string false

severity string false

userName string false

agentId string false

correlationId integer false

timeStamp string false

localizedMessage string false

logEntry Name: logEntry

Property Name Property Type Required

componentId string false

executionId string false

level string false

timestamp string false

message string false

LogicalNetworkIdentityInventory Name: LogicalNetworkIdentityInventory

Property Name Property Type Required

bPresent boolean false

identityType IdentityType false

permanentIdentity string false

currentIdentity string false

id string false

LogicalNetworkInterface Name: LogicalNetworkInterface

Appendix B - Model reference 115

Property Name Property Type Required

vendorName string false

fqdd string false

bPresent boolean false

vendorId string false

productName string false

identityList LogicalNetworkInterface false

productId string false

networkMode NetworkMode false

relativeBandwidthWeight integer false

maxBandwidth number false

portId string false

id string false

LogSeverity Enum: LogSeverity

Property Name Property Type

values ["CRITICAL", "ERROR", "WARNING", "INFO"]

ManagedDevice Name: ManagedDevice

Property Name Property Type Required

refId string true

deviceType DeviceType true

compliance CompliantState false

serviceTag string true

health DeviceHealth false

ipAddress string true

model string false

infraTemplateDate GregorianCalendar false

infraTemplateId string false

serverTemplateDate GregorianCalendar false

serverTemplateId string false

inventoryDate GregorianCalendar false

complianceCheckDate GregorianCalendar false

discoveredDate GregorianCalendar false

deviceGroupList DeviceGroupList false

116 Appendix B - Model reference

Property Name Property Type Required

detailLink Link false

operatingSystem string false

numberOfCPUs integer false

memoryInGB integer false

credId string false

nics integer false

discoverDeviceType DiscoverDeviceType true

failuresCount integer false

chassisId string false

firmwareUpdateTime string false

firmwareDeviceInventories FirmwareDeviceInventory false

facts string false

statusMessage DeviceState false

manufacturer string false

cpuType string false

healthMessage string false

systemId string false

config string false

hostname string false

refType string false

state DeviceState false

displayName string false

ManagedDeviceList Name: ManagedDeviceList

Property Name Property Type Required

totalCount integer false

managedDevices ManagedDevice true

MediaType Enum: MediaType

@Deprecated

Property Name Property Type

values ["SSD", "HDD", "ANY"]

Appendix B - Model reference 117

MemoryInventory Name: MemoryInventory

Property Name Property Type Required

model string false

manufacturer string false

fqdd string false

partNumber string false

bankLabel string false

currentOperatingSpeed integer false

instanceID string false

lastSystemInventoryTime string false

manufactureDate string false

memoryType string false

primaryStatus string false

rank string false

speed integer false

serialNumber string false

lastUpdateTime string false

id string false

size integer false

Network

Name: Network

Property Name Property Type Required

vlanId integer false

staticNetworkConfiguration StaticNetworkConfiguration false

description string false

name string false

id string false

type string false

static boolean false

NetworkConfiguration Name: NetworkConfiguration

Property Name Property Type Required

fabrics Fabric false

118 Appendix B - Model reference

Property Name Property Type Required

networks Network false

usedInterfaces Interface false

servertype string false

allUsedInterfaces Interface false

allNetworkIds [string] false

interfaces Fabric false

id string false

NetworkMode Enum: NetworkMode

Property Name Property Type

values ["UNKNOWN", "LAN", "ISCSI", "FCOE"]

ntpSettings Name: ntpSettings

Property Name Property Type Required

preferredNTPServer string false

secondaryNTPServer string false

OperatingSystemSupport Name: OperatingSystemSupport

Property Name Property Type Required

versions [string] false

operatingSystem string false

OSRepository Name: OSRepository

Property Name Property Type Required

createdDate string false

imageType string false

sourcePath string false

razorName string false

inUse boolean false

username string false

Appendix B - Model reference 119

Property Name Property Type Required

createdBy string false

password string false

name string false

id string false

state string false

Partition Name: Partition

Property Name Property Type Required

maximum integer false

minimum integer false

networks [string] false

fqdd string false

wwpn string false

networkObjects Network false

iscsiMacAddress string false

macAddress string false

partitionNo integer false

partitionIndex integer false

lanMacAddress string false

iscsiIQN string false

wwnn string false

portNo integer false

name string false

id string false

PhysicalDisk Name: PhysicalDisk

Property Name Property Type Required

fqdd string false

hotSpareStatus HotSpareStatus false

mediaType MediaType false

driveNumber integer false

size integer false

120 Appendix B - Model reference

PhysicalType Enum: PhysicalType

Property Name Property Type

values ["BLADE", "RACK", "SLED"]

ProcessorInventory Name: ProcessorInventory

Property Name Property Type Required

present boolean false

model string false

manufacturer string false

fqdd string false

cores integer false

enabledCores integer false

maxClockSpeed integer false

currentClockSpeed integer false

id string false

proxySettings Name: proxySettings

Property Name Property Type Required

userName string false

proxyServer string false

userCredentialEnabled boolean false

enabled boolean false

password string false

port string false

RAIDConfiguration Name: RAIDConfiguration

Property Name Property Type Required

externalSsdHotSpares [string] false

externalVirtualDisks VirtualDisk false

virtualDisks VirtualDisk false

externalHddHotSpares [string] false

Appendix B - Model reference 121

Property Name Property Type Required

hddHotSpares [string] false

ssdHotSpares [string] false

references Name: references

Property Name Property Type Required

policies integer false

devices integer false

totalReferences integer false

RejectedServer Name: RejectedServer

Property Name Property Type Required

refId string false

serviceTag string false

ipaddress string false

reason string false

RepositoryState

Name: RejectedServer

Property Name Property Type Required

refId string false

serviceTag string false

ipaddress string false

reason string false

RepositoryStatus Name: RepositoryStatus

Property Name Property Type

values [PENDING, COPYING, ERROR, AVAILABLE]

selectedAlerts Name: selectedAlerts

122 Appendix B - Model reference

Property Name Property Type Required

id string true

index string true

userName string true

SelectedNIC Name: SelectedNIC

Property Name Property Type Required

fqdd string false

cardNumber integer false

portNumber integer false

id string false

SelectedServer Name: SelectedServer

Property Name Property Type Required

refId string false

serviceTag string false

ipAddress string false

nics SelectedNIC false

componentId string false

matchUnordered boolean false

raidConfiguration RAIDConfiguration false

exactMatch boolean false

Server Name: Server

Property Name Property Type Required

managementIP string false

managementIPStatic boolean false

serviceTag string false

assetTag string false

health Health false

model string false

slotName string false

slotType ServerSlotType false

Appendix B - Model reference 123

Property Name Property Type Required

id string false

slot string false

supported boolean false

ServerJobStatus Name: ServerJobStatus

Property Name Property Type Required

createdDate string false

jobType string false

jobStatus string false

jobName string false

startedBy string false

ServerNetworkObjects Name: ServerNetworkObjects

Property Name Property Type Required

physicalType PhysicalType false

razorPolicyName string false

networkConfig NetworkConfiguration false

relatedSwitches [string] false

portConnections connected_switch false

fcInterfaces fc_interface false

fcoeInterfaces fc_interface false

serialNumber string false

server string false

name string false

ServerSlotType Enum: ServerSlotType

@Deprecated

Property Name Property Type

values ["HALF", "FULL", "QUARTER", "UNKNOWN"]

ServiceTemplate Name: ServiceTemplate

124 Appendix B - Model reference

Property Name Property Type Required

createdDate GregorianCalendar false

updatedBy string false

updatedDate GregorianCalendar false

firmwareRepository FirmwareRepository false

draft boolean false

templateName string false

templateDescription string false

wizardPageNumber integer false

assignedUsers User false

allUsersAllowed boolean false

enableApps boolean false

enableVMs boolean false

enableCluster boolean false

enableServer boolean false

enableStorage boolean false

templateValid ServiceTemplateValid false

templateLocked boolean false

templateVersion string false

lastDeployedDate GregorianCalendar false

manageFirmware boolean false

components component false

category string false

createdBy string false

attachments [string] false

id string false

ServiceTemplateCategory Name: ServiceTemplateCategory

Property Name Property Type Required

parameters ServiceTemplateSetting false

id string false

displayName string false

ServiceTemplateComponentSubType Enum: ServiceTemplateComponentSubType

Appendix B - Model reference 125

Property Name Property Type

values ["CLASS", "TYPE", "HYPERVISOR", "HYPERCONVERGED", "COMPUTEONLY", "STORAGEONLY"]

ServiceTemplateComponentType Enum: ServiceTemplateComponentType

Property Name Property Type

values [CONFIGURATION, TOR, STORAGE, SERVER, CLUSTER, VIRTUALMACHINE, SERVICE, SCALEIO, TEST, CLOUDLINK]

ServiceTemplateOption Name: ServiceTemplateOption

Property Name Property Type Required

dependencyValue string false

dependencyTarget string false

name string false

value string false

ServiceTemplateSetting Name: ServiceTemplateSetting

Property Name Property Type Required

min integer false

networks Network false

dependencyValue string false

dependencyTarget string false

optionsSortable boolean false

step integer false

requiredAtDeployment boolean false

hideFromTemplate boolean false

toolTip string false

infoIcon boolean false

possibleValues [string] false

possibleValuesDisplayName [string] false

maxLength integer false

networkConfiguration NetworkConfiguration false

raidConfiguration RAIDConfiguration false

max integer false

126 Appendix B - Model reference

Property Name Property Type Required

group string false

options ServiceTemplateOption false

generated boolean false

required boolean false

value string false

id string false

type ServiceTemplateSettingType false

readOnly boolean false

displayName string false

ServiceTemplateSettingType Enum: ServiceTemplateSettingType

Property Name Property Type

values [BOOLEAN, STRING, PASSWORD, INTEGER, "LIST", "TEXT", "NETWORKCONFIGURATION", VMVIRTUALDISKCONFIGURATION, "ENUMERATED", "RAIDCONFIGURATION", "BIOSCONFIGURATION", "RADIO", "STATICTEXT", "NIOCCONFIGURATION", "STORAGEPOOLDISKSCONFIGURATION", "PROTECTIONDOMAINSETTINGS", "OSCREDENTIAL", "CREDENTIAL", "LICENSEFILE", "SCALEIOCREDENTIAL", "STATICROUTESCONFIGURATION", "FAULTSETSETTINGS", "VDSSETTINGSCONFIGURATION"]

ServiceTemplateUploadRequest Name: ServiceTemplateUploadRequest

Property Name Property Type Required

encryptionPassword string false

templateName string false

allStandardUsers boolean false

managePermissions boolean false

useEncPwdFromBackup boolean false

createCategory boolean false

firmwarePackageId string false

assignedUsers [string] false

manageFirmware boolean false

description string false

category string false

content string false

Appendix B - Model reference 127

ServiceTemplateValid Name: ServiceTemplateValid

Property Name Property Type Required

valid boolean false

messages AsmDetailedMessage false

SoftwareBundle Name: SoftwareBundle

Property Name Property Type Required

deviceType string false

createdDate string false

updatedBy string false

updatedDate string false

softwareComponents SoftwareComponent false

userBundlePath string false

userBundle boolean false

userBundleHashMd5 string false

deviceModel string false

criticality string false

fwRepositoryId string false

bundleDate string false

version string false

description string false

link Link false

createdBy string false

name string false

id string false

SoftwareComponent Name: SoftwareComponent

Property Name Property Type Required

createdDate string false

updatedBy string false

updatedDate string false

deviceId string false

componentId string false

128 Appendix B - Model reference

Property Name Property Type Required

packageId string false

dellVersion string false

vendorVersion string false

subDeviceId string false

vendorId string false

subVendorId string false

hashMd5 string false

systemIDs [string] false

category string false

createdBy string false

componentType string false

name string false

id string false

path string false

SRSConnectorSettings Name: SRSConnectorSettings

Property Name Property Type Required

omeIP string false

omeUser string false

omePassword string false

omeAlertFilter string false

delayTimeH string false

delayTimeM string false

software_id string false

solution_sn string false

deviceType string false

esrsHostPort string false

registerUserID string false

registerPassword string false

state string false

logLevel string false

checkSSL boolean false

registerIP string false

restart string false

suspend string false

status string false

Appendix B - Model reference 129

Property Name Property Type Required

deviceKeyId string false

connectionType string false

phoneHomeIp string false

phoneHomePort string false

srsConnection boolean false

emailConnection boolean false

emailServerConfig emailServerConfig on page 107 false

SRSConnectorTestAlerts Name: SRSConnectorTestAlerts

Property Name Property Type Required

commandData string false NOTE: The value is tst0001. It will fail if the value is changed.

StaticNetworkConfiguration Name: StaticNetworkConfiguration

Property Name Property Type Required

ipAddress string false

subnet string false

gateway string false

primaryDns string false

secondaryDns string false

dnsSuffix string false

ipRange IpRange false

testProxyResponse Name: testProxyResponse

Property Name Property Type Required

testProxyResult boolean false

testProxyDescription string false

timeZone Name: timeZone

130 Appendix B - Model reference

Property Name Property Type Required

rawOffset integer false

dSTSavings integer false

displayName string false

iD string false

TroubleshootingBundleParams Name: TroubleshootingBundleParams

Property Name Property Type Required

serviceId string false

bundleDes string false

NOTE: The value is NETWORK.

filepath string false NOTE: Multiple backslashes in the path is a known behavior. No changes are required.

username string false

password string false

UIRaidLevel Enum: UIRaidLevel

Property Name Property Type

values ["raid0", "raid1", "raid5", "raid6", "raid10", "raid50", "raid60", noraid]

UpdateSnmpAlerts Name: UpdateSnmpAlerts

Property Name Property Type Required

selectedAlerts selectedAlerts on page 122 true

acknowledged boolean true

UpdateType Enum: UpdateType

Property Name Property Type

values [SERVICE, DEVICE, GATEWAY]

Appendix B - Model reference 131

URL Name: URL

Property Name Property Type Required

hashCode integer false

path string false

authority string false

query string false

protocol string false

file string false

host string false

ref string false

userInfo string false

port integer false

defaultPort integer false

content object false

UsageIdList Name: UsageIdList

Property Name Property Type Required

usageIds [string] false

User Name: User

Property Name Property Type Required

userName string true

createdDate GregorianCalendar false

updatedBy string false

updatedDate GregorianCalendar false

groupName string false

email string false

phoneNumber string false

systemUser boolean false

userSeqId integer false

updatePassword boolean false

domainName string true

groupDN string false

132 Appendix B - Model reference

Property Name Property Type Required

firstName string false

lastName string false

enabled boolean false

link Link false

role string true

createdBy string false

password string true

VirtualDisk Name: VirtualDisk

Property Name Property Type Required

raidLevel UIRaidlevel false

physicalDisks [string] false

mediaType MediaType false

controller string false

configuration VirtualDiskConfiguration false

VirtualDiskConfiguration

Name: VirtualDiskConfiguration

Property Name Property Type Required

raidlevel IpRange false

disktype DiskMediaType false

numberofdisks integer false

comparator ComparatorValue false

id string false

VM Name: VM

Property Name Property Type Required

vmIpaddress string false

vmManufacturer string false

vmModel string false

vmServiceTag string false

certificateName string false

Appendix B - Model reference 133

Manualsnet FAQs

If you want to find out how the V3.6 Dell works, you can view and download the Dell PowerFlex Manager V3.6 Solution API Guide on the Manualsnet website.

Yes, we have the API Guide for Dell V3.6 as well as other Dell manuals. All you need to do is to use our search bar and find the user manual that you are looking for.

The API Guide should include all the details that are needed to use a Dell V3.6. Full manuals and user guide PDFs can be downloaded from Manualsnet.com.

The best way to navigate the Dell PowerFlex Manager V3.6 Solution API Guide is by checking the Table of Contents at the top of the page where available. This allows you to navigate a manual by jumping to the section you are looking for.

This Dell PowerFlex Manager V3.6 Solution API Guide consists of sections like Table of Contents, to name a few. For easier navigation, use the Table of Contents in the upper left corner.

You can download Dell PowerFlex Manager V3.6 Solution API Guide free of charge simply by clicking the “download” button in the upper right corner of any manuals page. This feature allows you to download any manual in a couple of seconds and is generally in PDF format. You can also save a manual for later by adding it to your saved documents in the user profile.

To be able to print Dell PowerFlex Manager V3.6 Solution API Guide, simply download the document to your computer. Once downloaded, open the PDF file and print the Dell PowerFlex Manager V3.6 Solution API Guide as you would any other document. This can usually be achieved by clicking on “File” and then “Print” from the menu bar.