Create
POST v1/replication_partners
Description
Create a replication partner.
Normal Response Codes
201
HTTP Error Codes
400 401 404 409 500 503
Detail Error Codes
Request
| Parameter | Type | JSON Type | Description | Default | Mandatory | Deprecated |
|---|---|---|---|---|---|---|
| name | NsHostName | string | Name of replication partner. String of up to 63 alphanumeric and can include hyphens characters but cannot start with hyphen. | Yes | ||
| description | NsDescription | string | Description of replication partner. String of up to 255 printable ASCII characters. Example: '99.9999% availability'. | '' | No | |
| secret | NsPassword | string | Replication partner shared secret, used for mutual authentication of the partners. String of 8 to 255 printable characters excluding ampersand, backslash and ~;[]`. Example: 'password-91'. | Yes | ||
| control_port | NsPort | number | Port number of partner control interface. Integer value between 0-65535 representing TCP/IP TCP/IP port. Example: 1234. | 4213 | No | |
| hostname | NsObjectName | string | IP address or hostname of partner interface. This must be the partner's Group Management IP address. String of up to 64 alphanumeric characters, - and . and : are allowed after first character. Example: 'myobject-5'. | Yes | ||
| repl_hostname | NsObjectName | string | IP address or hostname of partner data interface. String of up to 64 alphanumeric characters, - and . and : are allowed after first character. Example: 'myobject-5'. | (regular hostnam) | No | |
| data_port | NsPort | number | Port number of partner data interface. Integer value between 0-65535 representing TCP/IP TCP/IP port. Example: 1234. | 4214 | No | |
| pool_id | NsObjectID | string | The pool ID where volumes replicated from this partner will be created. Replica volumes created as clones ignore this parameter and are always created in the same pool as their parent volume. A 42 digit hexadecimal number. Example: '2a0df0fe6f7dc7bb16000000000000000000004817'. | (ID for 'default' pool) | No | |
| folder_id | NsObjectID | string | The Folder ID within the pool where volumes replicated from this partner will be created. A 42 digit hexadecimal number. Example: '2a0df0fe6f7dc7bb16000000000000000000004817'. | No | ||
| match_folder | NsBoolean | boolean | Indicates whether to match the upstream volume's folder on the downstream. Possible values: 'true', 'false'. | No | ||
| subnet_label | NsObjectName | string | Label of the subnet used to replicate to this partner. String of up to 64 alphanumeric characters, - and . and : are allowed after first character. Example: 'myobject-5'. | Yes | ||
| subnet_type | NsSubnetType | string enum | Type of the subnet used to replicate to this partner. Possible values: 'invalid', 'unconfigured', 'mgmt', 'data', 'mgmt_data'. | No |
JSON Request
Response
| Parameter | Type | JSON Type | Description | Deprecated |
|---|---|---|---|---|
| id | NsObjectID | string | Identifier for a replication partner. A 42 digit hexadecimal number. Example: '2a0df0fe6f7dc7bb16000000000000000000004817'. | |
| name | NsHostName | string | Name of replication partner. String of up to 63 alphanumeric and can include hyphens characters but cannot start with hyphen. | |
| full_name | NsHostName | string | Fully qualified name of replication partner. String of up to 63 alphanumeric and can include hyphens characters but cannot start with hyphen. | |
| search_name | NsSearchName | string | Name of replication partner used for object search. Alphanumeric string, up to 64 characters including hyphen, period, colon. Example: 'vol:1'. | |
| description | NsDescription | string | Description of replication partner. String of up to 255 printable ASCII characters. Example: '99.9999% availability'. | |
| creation_time | NsTime | number | Time when this replication partner was created. Seconds since last epoch i.e. 00:00 January 1, 1970. Example: '3400'. | |
| last_modified | NsTime | number | Time when this replication partner was last modified. Seconds since last epoch i.e. 00:00 January 1, 1970. Example: '3400'. | |
| control_port | NsPort | number | Port number of partner control interface. Integer value between 0-65535 representing TCP/IP TCP/IP port. Example: 1234. | |
| hostname | NsObjectName | string | IP address or hostname of partner interface. This must be the partner's Group Management IP address. String of up to 64 alphanumeric characters, - and . and : are allowed after first character. Example: 'myobject-5'. | |
| repl_hostname | NsObjectName | string | IP address or hostname of partner data interface. String of up to 64 alphanumeric characters, - and . and : are allowed after first character. Example: 'myobject-5'. | |
| data_port | NsPort | number | Port number of partner data interface. Integer value between 0-65535 representing TCP/IP TCP/IP port. Example: 1234. | |
| is_alive | NsBoolean | boolean | Whether the partner is available, and responding to pings. Possible values: 'true', 'false'. | |
| last_keepalive_error | NsString | string | Most recent error while attempting to ping the partner. Plain string. | |
| cfg_sync_status | NsPartnerCfgSyncStatus | string enum | Indicates whether all volumes and volume collections have been synced to the partner. Possible values: 'N/A', 'Yes', 'No'. | |
| last_sync_error | NsString | string | Most recent error seen while attempting to sync objects to the partner. Plain string. | |
| array_serial | NsString | string | Serial number of group leader array of the partner. Plain string. | |
| version | NsUnsignedLong | number | Replication version of the partner. Unsigned 64-bit integer. Example: 1234. | |
| pool_id | NsObjectID | string | The pool ID where volumes replicated from this partner will be created. Replica volumes created as clones ignore this parameter and are always created in the same pool as their parent volume. A 42 digit hexadecimal number. Example: '2a0df0fe6f7dc7bb16000000000000000000004817'. | |
| pool_name | NsObjectName | string | The pool name where volumes replicated from this partner will be created. String of up to 64 alphanumeric characters, - and . and : are allowed after first character. Example: 'myobject-5'. | |
| folder_id | NsObjectID | string | The Folder ID within the pool where volumes replicated from this partner will be created. A 42 digit hexadecimal number. Example: '2a0df0fe6f7dc7bb16000000000000000000004817'. | |
| folder_name | NsObjectName | string | The Folder name within the pool where volumes replicated from this partner will be created. String of up to 64 alphanumeric characters, - and . and : are allowed after first character. Example: 'myobject-5'. | |
| match_folder | NsBoolean | boolean | Indicates whether to match the upstream volume's folder on the downstream. Possible values: 'true', 'false'. | |
| paused | NsBoolean | boolean | Indicates whether replication traffic from/to this partner has been halted. Possible values: 'true', 'false'. | |
| subnet_label | NsObjectName | string | Label of the subnet used to replicate to this partner. String of up to 64 alphanumeric characters, - and . and : are allowed after first character. Example: 'myobject-5'. | |
| subnet_type | NsSubnetType | string enum | Type of the subnet used to replicate to this partner. Possible values: 'invalid', 'unconfigured', 'mgmt', 'data', 'mgmt_data'. | |
| throttles | NsThrottles | Array of NsThrottle | Throttles used while replicating from/to this partner. All the throttles for the partner. | |
| throttled_bandwidth | NsUnsignedLong | number | Current throttled bandwidth to this partner in megabits per second. Unsigned 64-bit integer. Example: 1234. | |
| throttled_bandwidth_kbps | NsUnsignedLong | number | Current throttled bandwidth to this partner in kilobits per second. Unsigned 64-bit integer. Example: 1234. | |
| subnet_network | NsIPAddress | string | Subnet used to replicate to this partner. Four numbers in the range [0,255] separated by periods. Example: '128.0.0.1'. | |
| subnet_netmask | NsIPNetmask | string | Subnet mask used to replicate to this partner. A netmask expressed as a 32 bit binary value must have the highest bit set (2^31) and the lowest bit clear (2^0) with the first zero followed by only zeros. Example: '255.255.255.0'. |
JSON Response