/connmgr/v1/connections/<connection_name> -d '<data>': PUT

Updates a connection.

The /connmgr/v1/connections/<connection_name> -d '<data>': PUT endpoint updates an existing connection with the attribute values that are specified in the request data. Attributes that are not updated keep the same values that they had before the update. The following attributes can be updated: name, type, cluster, datasource, and site. For more information about the attributes in the request data, see Endpoints for working with connection management. The following table shows which roles can access this REST API endpoint:
Table 1. Access by role
Data admin Data user Collection Admin Admin Service user
✓ Χ Χ Χ Χ

Synopsis of the request URL

curl -k -H 'Authorization: Bearer <token>' https://<spectrum_discover_host>/connmgr/v1/
connections/<connection_name> -d '<data>' -X PUT -H "Content-Type: application/json"

Supported request types, input fields, and response formats

Supported request types:
  • PUT
Supported input fields:
JSON input is expected. Use a Content type: application/json header in the HTTP protocol request.
name
The unique name of this connection.
cluster
The cluster ID of the IBM Storage Scale cluster or IBM Cloud® Object Storage system UUID.
platform
[ "Spectrum Scale" | "IBM® COS" | "NFS" | "S3" | "IBM Storage Protect" ].
datasource
Name of individual file system or vault. For example, scratch.
site
Physical location of data from this connection. This field is optional.
host
The hostname or IP address of the interface node for scanning. This field is not mandatory for creating a connection, but is required for automated scan support.
user
The username to connect to the source data system with. This field is not mandatory for creating a connection, but is required for automated scan support.
password
The password on the source data system belonging to the user ID specified above. This field is not mandatory for creating a connection, but is required for automated scan support.
additional_info
Connection-type specific information. This field is not mandatory for creating a connection, but is required for automated scan support.
Supported response formats:
  • JSON

Examples

  1. The following example updates connection con01 to con02:
    1. Issue the following request on one line:
      curl -k -H 'Authorization: Bearer <token>'https://<spectrum_discover_host>/connmgr/v1/
connections/con01 -d'{"name":"con02","platform":"Spectrum Scale","cluster":
"modevvm19.metro.labs.cpr.com","datasource":"gpfs1", "site":"datasite03"}' -X PUT 
-H "Content-Type:application/json"
    2. The following response is returned: 
      Connection 'con02' updated
    To verify that the policy is updated, issue a GET request to list the information about the specified connection or about all the connections in the system. For more information, see /connmgr/v1/connections: GET and /connmgr/v1/connections/<connection_name>: GET.