Create

Parameter	Type	JSON Type	Description	Default	Mandatory
name	NsHostName	string	Name of replication partner. String of up to 63 alphanumeric and can include hyphens characters but cannot start with hyphen.		true
description	NsDescription	string	Description of replication partner. String of up to 255 printable ASCII characters. Example: '99.9999% availability'.	''	false
secret	NsPassword	string	Replication partner shared secret, used for mutual authentication of the partners. String of 8 to 255 printable characters excluding ampersand and ;[]`. Example: 'password-91'.		true
control_port	NsPort	number	Port number of partner control interface. Positive integer value up to 65535 representing TCP/IP port. Example: 1234.	4213	false
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'.		true
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 hostname)	false
data_port	NsPort	number	Port number of partner data interface. Positive integer value up to 65535 representing TCP/IP port. Example: 1234.	4214	false
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)	false
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'.	''	false
match_folder	NsBoolean	boolean	Indicates whether to match the upstream volume's folder on the downstream. Possible values: 'true', 'false'.	false	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'.		true
subnet_type	NsSubnetType	string enum	Type of the subnet used to replicate to this partner. Possible values: 'invalid', 'unconfigured', 'mgmt', 'data', 'mgmt_data'.	mgmt	false
throttles	NsThrottles	Array of NsThrottle	Throttles used while replicating from/to this partner. All the throttles for the partner.		false

JSON Request

            

{
   "data" : {
      "subnet_type" : "mgmt",
      "subnet_label" : "subnet1",
      "name" : "partner1",
      "hostname" : "hostname",
      "secret" : 12341234134
      "throttles":[
        {"name":    "name-two",
         "description":    "desc-two",
         "days":    "wednesday,friday",
         "thr_at_time":    10801,
         "thr_until_time":    14400,
         "thr_bandwidth":    19
        },
        {"name":    "name-two",
         "description":    "desc-two",
         "days":    "wednesday",
         "thr_at_time":    14500,
         "thr_until_time":    15400,
         "thr_bandwidth":    18
        }
    ]
   }
}

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. Positive integer value up to 65535 representing 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. Positive integer value up to 65535 representing TCP/IP port. Example: 1234.
is_alive	NsBoolean	boolean	Whether the partner is available, and responding to pings. Possible values: 'true', 'false'.
partner_group_uid	NsUnsignedLong	number	Replication partner group uid. Unsigned 64-bit integer. Example: 1234.
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 bandwidth throttle for this partner, expressed either as megabits per second or as the largest possible 64-bit signed integer (9223372036854775807) to indicate that there is no throttle. This attribute is superseded by throttled_bandwidth_current. Unsigned 64-bit integer. Example: 1234.	Yes
throttled_bandwidth_current	NsSignedLong	number	Current bandwidth throttle for this partner, expressed either as megabits per second or as -1 to indicate that there is no throttle. Signed 64-bit integer. Example: -1234.
throttled_bandwidth_kbps	NsUnsignedLong	number	Current bandwidth throttle for this partner, expressed either as kilobits per second or as the largest possible 64-bit signed integer (9223372036854775807) to indicate that there is no throttle. This attribute is superseded by throttled_bandwidth_current_kbps. Unsigned 64-bit integer. Example: 1234.	Yes
throttled_bandwidth_current_kbps	NsSignedLong	number	Current bandwidth throttle for this partner, expressed either as kilobits per second or as -1 to indicate that there is no throttle. Signed 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'.
volume_collection_list	NsVolumeCollectionList	Array of NsVolumeCollectionSummary	List of volume collections that are replicating from/to this partner. List of volume collections.
volume_collection_list_count	NsUnsignedLong	number	Count of volume collections that are replicating from/to this partner. Unsigned 64-bit integer. Example: 1234.
volume_list	NsVolumeList	Array of NsVolumeSummary	List of volumes that are replicating from/to this partner. List of volumes.
volume_list_count	NsUnsignedLong	number	Count of volumes that are replicating from/to this partner. Unsigned 64-bit integer. Example: 1234.
replication_direction	NsReplDirection	string enum	Direction of replication configured with this partner. Possible values: 'none', 'downstream', 'upstream', 'bi_directional'.

JSON Response

            

{
   "data" : {
      "subnet_type" : "mgmt,data",
      "search_name" : "partner1",
      "name" : "partner1",
      "last_modified" : 1426776060,
      "data_port" : 4214,
      "hostname" : "hostname",
      "paused" : false,
      "full_name" : "partner1",
      "description" : "",
      "subnet_label" : "subnet1",
      "pool_id" : "0a00000000000004d3000000000000000000000001",
      "control_port" : 4213,
      "partner_group_uid" : 0,
      "creation_time" : 1426776060,
      "id" : "0800000000000004d3000000000000000000000001",
      "pool_name" : "default"
      "throttles":[
        {"id":"0e00000000000004d3000000000000000000000002",
         "name":"",
         "description":"desc-two",
         "creation_time":1460477565,
         "last_modified":1460477565,
         "partner_id":"0800000000000004d3000000000000000000000001",
         "thr_partner_id":1,
         "days":"wednesday,friday",
         "thr_at_time":10801,
         "thr_until_time":14400,
         "thr_bandwidth":19,
         "thr_bandwidth_kbps":19000,
         "thr_bandwidth_limit_kbps":19000
         },
        {"id":"0e00000000000004d3000000000000000000000003",
         "name":"",
         "description":"desc-two",
         "creation_time":1460477565,
         "last_modified":1460477565,
         "partner_id":"0800000000000004d3000000000000000000000001",
         "thr_partner_id":1,
         "days":"wednesday",
         "thr_at_time":14500,
         "thr_until_time":15400,
         "thr_bandwidth":18,
         "thr_bandwidth_kbps":18000,
         "thr_bandwidth_limit_kbps":18000
        }
    ]
   }
}