This URL updates the vIPS controller.
Resource URL
PUT /cloud/connector/<id>
Request Parameters
URL Parameters
| Field Name | Description | Data Type | Mandatory |
|---|---|---|---|
| id | Controller id | Number | Yes |
Payload Request Parameters
| Field Name | Description | Data Type | Mandatory |
|---|---|---|---|
| name | Controller name | String | Yes |
| isHA | Specifies if the controller is in high availability mode or not | Boolean | Yes |
| serviceIp | Controller service IP, if provided | String | No |
| haTimeout | High availability timeout in minutes | Number | No |
| sharedSecret | Shared secret between the Manager and controller | String | Yes |
| privateCommunicationSubnet | Private controller communication subnet CIDR | String | Yes |
| description | Controller description | String | No |
| cloud | Cloud access details | Object | Yes |
Details of fields in cloud:
| Field Name | Description | Data Type | Mandatory |
|---|---|---|---|
| type | Type of cloud environment. Supported value:
|
String | Yes |
| awsDetails | AWS cloud details | Object | Yes |
| azureDetails | Azure cloud details | Object | Yes |
Details of fields in AWS:
| Field Name | Description | Data Type | Mandatory |
|---|---|---|---|
| useIAMRole | Specifies if the IAM roles in Manager machines are used to access the AWS cloud or not | Boolean | Yes |
| region | Cloud access region | String | Yes |
| accessKey | Cloud access key | String | Yes |
| secretKey | Cloud access secret key | String | Yes |
Details of fields in Azure:
| Field Name | Description | Data Type | Mandatory |
|---|---|---|---|
| directoryId | Azure directory id | String | Yes |
| applicationKey | Azure app application key | String | Yes |
| applicationId | Azure app application id | String | Yes |
| subscription | Azure app subscription id | String | Yes |
Response Parameters
Following fields are returned if the request parameters are correct, otherwise error details are returned:
| Field Name | Description | Data Type |
|---|---|---|
| status | Set to 1 if the update was successful | Number |
Example
Request
PUT https://<NSM_IP>/sdkapi/cloud/connector/103
Payload
{
'privateCommunicationSubnet': '1.1.1.0/24',
'sharedSecret': 'ControllerSharedSecretKey',
'cloud':
{
'type': 'AMAZON',
'awsDetails': {
'secretKey': 'ControllerCloudSecretKey',
'region': 'US_WEST_2',
'accessKey': 'ControllerCloudAccessKey'
}
},
'description': 'Demo Controller'
} Response
{
"status": 1
} Error Information
Following error codes are returned by this URL:
| No | HTTP Error Code | SDK API errorId | SDK API errorMessage |
|---|---|---|---|
| 1 | 500 | 1001 | Internal error message: internal server error |
| 2 | 400 | 1105 | Invalid domain |
| 3 | 400 | 11001 | Cloud details are required |
| 4 | 400 | 11001 | Cloud type is required |
| 5 | 400 | 11001 | Cloud type should be one of: <list of allowed values> |
| 6 | 400 | 11001 | Cloud region should be one of: <list of allowed regions> |
| 7 | 400 | 11001 | Shared secret is required |
| 8 | 400 | 11001 | Private communication subnet is required |
| 9 | 400 | 1701 | Invalid CIDR notation |