EMC ViPR REST API

Search (SHIFT+S)

API Reference


Update Custom Config

PUT /config/controller/{id}

Modify a config.

idURN of the config

Required Roles

Requires one of the following roles:

  • SYSTEM_ADMIN
  • RESTRICTED_SYSTEM_ADMIN

Request Payload

All parameters are required unless otherwise stated.

Field Description Type Notes
<config_update>
<value> The config value to be changed String
</config_update>

Response Body

NamedRelatedResourceRep

Field Description Type Notes
<config>
<scope>    
<type> The scope type String
<value> The scope value String
</scope>      
<value> The config value String
<registered> Whether or not the config is registered. When a config is not registered, the config is not usable. Boolean
<system_default> Whether or not the config is system generated. Boolean
<config_type>    
<name> The config type name String
<link> The link to the config type object
</config_type>      
<name> The name assigned to this resource in ViPR. The resource name is set by a user and can be changed at any time. It is not a unique identifier. String
<id> An identifier that is generated by ViPR when the resource is created. The resource ID is guaranteed to be unique and immutable across all virtual data centers for all time. URI
<link> A hyperlink to the details for this resource
<creation_time> A timestamp that shows when this resource was created in ViPR DateTime
<tags> Keywords and labels that can be added by a user to a resource to make it easy to find when doing a search.
<tag> String 0-* Elements
</tags>
<inactive> Whether or not the resource is inactive. When a user removes a resource, the resource is put in this state before it is removed from the ViPR database. Boolean
<global> Boolean
<remote> Boolean
<vdc>    
<id> ViPR ID of the related object URI
<link> A hyperlink to the related object
</vdc>      
<internal> Whether or not the resource is an internal resource. Boolean
</config>