Product Documentation

link_definition

Oct 21, 2015

Links configured and their property

Properties

Name Data Type Read-Only? Description
enabled
<Boolean>
No

Link enabled or not

Possible values = [true, false]

filterrules
<[Object,...]>
No
filter rules associated with link
filterrules.enabled
<Boolean>
No

Filter rule enabled or disabled

Possible values = [true, false]

filterrules.wccpservicegroups
<[Object,...]>
No
WCCP service group IDs. Note: Not supported on CB 4000 and CB 5000 platform.
wccpservicegroups.excluded
<Boolean>
No

If true, use the rule component as an exclude entity

Possible values = [true, false]

wccpservicegroups.groupid
<Integer>
No

groupid to be used for this rule

Minimum value = 51

Maximum value = 255

filterrules.vlans
<[Object,...]>
No
VLAN IDs for filter rules. Note: Not supported on CB 4000 and CB 5000 platform.
vlans.vlanid
<Integer>
No

vlan id to be used for this rule

Minimum value = 1

Maximum value = 4094

vlans.excluded
<Boolean>
No

If true, use the rule component as an exclude entity

Possible values = [true, false]

filterrules.interfaces
<[Object,...]>
No
List of interface(Adapter) names for link. Note: Not supported on CB 4000 and CB 5000 platform
interfaces.excluded
<Boolean>
No

If true, use the rule component as an exclude entity

Possible values = [true, false]

interfaces.interfacename
<String>
No

interface to be used for this rule

filterrules.srcethernetaddresses
<[Object,...]>
No
List of source ethernet addresses to be included or excludedin filter rules. Note: Not supported on CB 4000 and CB 5000 platform
srcethernetaddresses.excluded
<Boolean>
No

If true, use the rule component as an exclude entity

Possible values = [true, false]

srcethernetaddresses.srcetheraddress
<String>
No
filterrules.srcipaddresses
<[Object,...]>
No
list of source IPs to be included or excluded in filter rules
srcipaddresses.excluded
<Boolean>
No

If true, use the rule component as an exclude entity

Possible values = [true, false]

srcipaddresses.srcipaddress
<Object>
No
srcipaddress to be used for this rule
dstipaddress.rangetype
<String>
No

Use left/right fields for hyphen seperated IP range, ipaddressmask field for IP/mask, ipaddress field for IP address.

Possible values = [hyphen seperated, ipmask, ipaddress]

dstipaddress.ipaddressmask
<String>
No

IP adreess and mask representation . (IPv4/IPv6 string).

Bitmask = Optional (format IP[/bitmask])

dstipaddress.left
<String>
No
dstipaddress.ipaddress
<String>
No
dstipaddress.right
<String>
No
filterrules.dstipaddresses
<[Object,...]>
No
List of destination IPs to be included or excluded in filter rules
dstipaddresses.excluded
<Boolean>
No

If true, use the rule component as an exclude entity

Possible values = [true, false]

dstipaddresses.dstipaddress
<Object>
No
dstipaddress to be used for this rule
dstipaddress.rangetype
<String>
No

Use left/right fields for hyphen seperated IP range, ipaddressmask field for IP/mask, ipaddress field for IP address.

Possible values = [hyphen seperated, ipmask, ipaddress]

dstipaddress.ipaddressmask
<String>
No

IP adreess and mask representation . (IPv4/IPv6 string).

Bitmask = Optional (format IP[/bitmask])

dstipaddress.left
<String>
No
dstipaddress.ipaddress
<String>
No
dstipaddress.right
<String>
No
filterrules.dstethernetaddresses
<[Object,...]>
No
List of destination ethernet addresses to be included or excludedin filter rules. Note: Not supported on CB 4000 and CB 5000 platform
dstethernetaddresses.excluded
<Boolean>
No

If true, use the rule component as an exclude entity

Possible values = [true, false]

dstethernetaddresses.dstetheraddress
<String>
No
order
<Integer>
No

Precedance order of link

Minimum value = 1

name
<String>
No

Name of the link

Minimum length = 1

linkid
<Integer>
Yes

Link Id unique for every link and mapped with name

maxbandwidthout
<Long>
No

Maximum outgoing bandwidth for link in units of bps. Max value is 10 gbps for CB 4000 and CB 5000 but only 1 gbps for other platform. Note: Not supported on CB 4000 and CB 5000 platform if link type is LAN. This is a reequired key on all platrform but on CB 4000 and CB 5000 if link type is LAN then not required.

Minimum value = 56000

Maximum value = 10000000000

maxbandwidthin
<Long>
No

Maximum incoming bandwidth for link in units of bps. Note: Not supported on CB 4000 and CB 5000 platform, but a required key for add operation on all other platform.

Minimum value = 56000

Maximum value = 1000000000

propertyflags
<String>
Yes

Flag to identify the property of link

modified
<Boolean>
Yes

Link has been modified or not

Possible values = [true, false]

linktype
<String>
No

Type of link WAN or LAN

Possible values = [LAN, WAN]

Operations

Hinweis

Mandatory parameters are marked in red and placeholder content is marked in <green>.

ADD

Use this operation to create a link

HTTP Method: POST

URL: https://<cb_ip_address>/cb/nitro/v1/config/link_definition

Request Headers:

Authorization: Basic <base64 encoded(username:password)>
Content-Type: application/vnd.com.citrix.cloudbridge.link_definition+json

Request Payload: JSON

{"link_definition":{
"enabled": <boolean_value>,
"filterrules": [{
"enabled": <boolean_value>,
"wccpservicegroups": [{
"excluded": <boolean_value>,
"groupid": <integer_value>
}, ...],
"vlans": [{
"vlanid": <integer_value>,
"excluded": <boolean_value>
}, ...],
"interfaces": [{
"excluded": <boolean_value>,
"interfacename": <string_value>
}, ...],
"srcethernetaddresses": [{
"excluded": <boolean_value>,
"srcetheraddress": <string_value>
}, ...],
"srcipaddresses": [{
"excluded": <boolean_value>,
"srcipaddress": {
"rangetype": <string_value>,
"ipaddressmask": <string_value>,
"left": <string_value>,
"ipaddress": <string_value>,
"right": <string_value>
}
}, ...],
"dstipaddresses": [{
"excluded": <boolean_value>,
"dstipaddress": {
"rangetype": <string_value>,
"ipaddressmask": <string_value>,
"left": <string_value>,
"ipaddress": <string_value>,
"right": <string_value>
}
}, ...],
"dstethernetaddresses": [{
"excluded": <boolean_value>,
"dstetheraddress": <string_value>
}, ...]
}, ...],
"order": <integer_value>,
"name": <string_value>,
"maxbandwidthout": <long_value>,
"maxbandwidthin": <long_value>,
"linktype": <string_value>
}}

Response Headers:

Content-Type: application/vnd.com.citrix.cloudbridge.link_definition+json

Response Payload: JSON

{"link_definition":{
"enabled": <boolean_value>,
"filterrules": [{
"enabled": <boolean_value>,
"wccpservicegroups": [{
"excluded": <boolean_value>,
"groupid": <integer_value>
}, ...],
"vlans": [{
"vlanid": <integer_value>,
"excluded": <boolean_value>
}, ...],
"interfaces": [{
"excluded": <boolean_value>,
"interfacename": <string_value>
}, ...],
"srcethernetaddresses": [{
"excluded": <boolean_value>,
"srcetheraddress": <string_value>
}, ...],
"srcipaddresses": [{
"excluded": <boolean_value>,
"srcipaddress": {
"rangetype": <string_value>,
"ipaddressmask": <string_value>,
"left": <string_value>,
"ipaddress": <string_value>,
"right": <string_value>
},
}, ...],
"dstipaddresses": [{
"excluded": <boolean_value>,
"dstipaddress": {
"rangetype": <string_value>,
"ipaddressmask": <string_value>,
"left": <string_value>,
"ipaddress": <string_value>,
"right": <string_value>
},
}, ...],
"dstethernetaddresses": [{
"excluded": <boolean_value>,
"dstetheraddress": <string_value>
}, ...],
}, ...],
"order": <integer_value>,
"name": <string_value>,
"linkid": <integer_value>,
"maxbandwidthout": <long_value>,
"maxbandwidthin": <long_value>,
"propertyflags": <string_value>,
"modified": <boolean_value>,
"linktype": <string_value>
}}

DELETE

Use this operation to delete a link

HTTP Method: DELETE

URL: https://<cb_ip_address>/cb/nitro/v1/config/link_definition/<name>

Request Headers:

Authorization: Basic <base64 encoded(username:password)>

Response Payload: EMPTY

GET (ALL)

Use this operation to get list of delegate users

HTTP Method: GET

URL: https://<cb_ip_address>/cb/nitro/v1/config/link_definition

Request Headers:

Authorization: Basic <base64 encoded(username:password)>
Accept: application/vnd.com.citrix.cloudbridge.link_definition_list+json

Response Headers:

Content-Type: application/vnd.com.citrix.cloudbridge.link_definition_list+json

Response Payload: JSON

{"link_definition": [{
"enabled": <boolean_value>,
"filterrules": [{
"enabled": <boolean_value>,
"wccpservicegroups": [{
"excluded": <boolean_value>,
"groupid": <integer_value>
}, ...],
"vlans": [{
"vlanid": <integer_value>,
"excluded": <boolean_value>
}, ...],
"interfaces": [{
"excluded": <boolean_value>,
"interfacename": <string_value>
}, ...],
"srcethernetaddresses": [{
"excluded": <boolean_value>,
"srcetheraddress": <string_value>
}, ...],
"srcipaddresses": [{
"excluded": <boolean_value>,
"srcipaddress": {
"rangetype": <string_value>,
"ipaddressmask": <string_value>,
"left": <string_value>,
"ipaddress": <string_value>,
"right": <string_value>
},
}, ...],
"dstipaddresses": [{
"excluded": <boolean_value>,
"dstipaddress": {
"rangetype": <string_value>,
"ipaddressmask": <string_value>,
"left": <string_value>,
"ipaddress": <string_value>,
"right": <string_value>
},
}, ...],
"dstethernetaddresses": [{
"excluded": <boolean_value>,
"dstetheraddress": <string_value>
}, ...],
"enabled": <boolean_value>,
"wccpservicegroups": [{
"excluded": <boolean_value>,
"groupid": <integer_value>
}, ...],
"vlans": [{
"vlanid": <integer_value>,
"excluded": <boolean_value>
}, ...],
"interfaces": [{
"excluded": <boolean_value>,
"interfacename": <string_value>
}, ...],
"srcethernetaddresses": [{
"excluded": <boolean_value>,
"srcetheraddress": <string_value>
}, ...],
"srcipaddresses": [{
"excluded": <boolean_value>,
"srcipaddress": {
"rangetype": <string_value>,
"ipaddressmask": <string_value>,
"left": <string_value>,
"ipaddress": <string_value>,
"right": <string_value>
},
}, ...],
"dstipaddresses": [{
"excluded": <boolean_value>,
"dstipaddress": {
"rangetype": <string_value>,
"ipaddressmask": <string_value>,
"left": <string_value>,
"ipaddress": <string_value>,
"right": <string_value>
},
}, ...],
"dstethernetaddresses": [{
"excluded": <boolean_value>,
"dstetheraddress": <string_value>
}, ...],
}, ...],
"order": <integer_value>,
"name": <string_value>,
"linkid": <integer_value>,
"maxbandwidthout": <long_value>,
"maxbandwidthin": <long_value>,
"propertyflags": <string_value>,
"modified": <boolean_value>,
"linktype": <string_value>
}, ...]}

GET

Use this operation to get list of delegate users

HTTP Method: GET

URL: https://<cb_ip_address>/cb/nitro/v1/config/link_definition/<name>

Request Headers:

Authorization: Basic <base64 encoded(username:password)>
Accept: application/vnd.com.citrix.cloudbridge.link_definition+json

Response Headers:

Content-Type: application/vnd.com.citrix.cloudbridge.link_definition+json

Response Payload: JSON

{"link_definition":{
"enabled": <boolean_value>,
"filterrules": [{
"enabled": <boolean_value>,
"wccpservicegroups": [{
"excluded": <boolean_value>,
"groupid": <integer_value>
}, ...],
"vlans": [{
"vlanid": <integer_value>,
"excluded": <boolean_value>
}, ...],
"interfaces": [{
"excluded": <boolean_value>,
"interfacename": <string_value>
}, ...],
"srcethernetaddresses": [{
"excluded": <boolean_value>,
"srcetheraddress": <string_value>
}, ...],
"srcipaddresses": [{
"excluded": <boolean_value>,
"srcipaddress": {
"rangetype": <string_value>,
"ipaddressmask": <string_value>,
"left": <string_value>,
"ipaddress": <string_value>,
"right": <string_value>
},
}, ...],
"dstipaddresses": [{
"excluded": <boolean_value>,
"dstipaddress": {
"rangetype": <string_value>,
"ipaddressmask": <string_value>,
"left": <string_value>,
"ipaddress": <string_value>,
"right": <string_value>
},
}, ...],
"dstethernetaddresses": [{
"excluded": <boolean_value>,
"dstetheraddress": <string_value>
}, ...],
"enabled": <boolean_value>,
"wccpservicegroups": [{
"excluded": <boolean_value>,
"groupid": <integer_value>
}, ...],
"vlans": [{
"vlanid": <integer_value>,
"excluded": <boolean_value>
}, ...],
"interfaces": [{
"excluded": <boolean_value>,
"interfacename": <string_value>
}, ...],
"srcethernetaddresses": [{
"excluded": <boolean_value>,
"srcetheraddress": <string_value>
}, ...],
"srcipaddresses": [{
"excluded": <boolean_value>,
"srcipaddress": {
"rangetype": <string_value>,
"ipaddressmask": <string_value>,
"left": <string_value>,
"ipaddress": <string_value>,
"right": <string_value>
},
}, ...],
"dstipaddresses": [{
"excluded": <boolean_value>,
"dstipaddress": {
"rangetype": <string_value>,
"ipaddressmask": <string_value>,
"left": <string_value>,
"ipaddress": <string_value>,
"right": <string_value>
},
}, ...],
"dstethernetaddresses": [{
"excluded": <boolean_value>,
"dstetheraddress": <string_value>
}, ...],
}, ...],
"order": <integer_value>,
"name": <string_value>,
"linkid": <integer_value>,
"maxbandwidthout": <long_value>,
"maxbandwidthin": <long_value>,
"propertyflags": <string_value>,
"modified": <boolean_value>,
"linktype": <string_value>
}}

MODIFY

Use this operation to update a user from list of delegate users

HTTP Method: PUT

URL: https://<cb_ip_address>/cb/nitro/v1/config/link_definition/<name>

Request Headers:

Authorization: Basic <base64 encoded(username:password)>
Content-Type: application/vnd.com.citrix.cloudbridge.link_definition+json

Request Payload: JSON

{"link_definition":{
"enabled": <boolean_value>,
"filterrules": [{
"enabled": <boolean_value>,
"wccpservicegroups": [{
"excluded": <boolean_value>,
"groupid": <integer_value>
}, ...],
"vlans": [{
"vlanid": <integer_value>,
"excluded": <boolean_value>
}, ...],
"interfaces": [{
"excluded": <boolean_value>,
"interfacename": <string_value>
}, ...],
"srcethernetaddresses": [{
"excluded": <boolean_value>,
"srcetheraddress": <string_value>
}, ...],
"srcipaddresses": [{
"excluded": <boolean_value>,
"srcipaddress": {
"rangetype": <string_value>,
"ipaddressmask": <string_value>,
"left": <string_value>,
"ipaddress": <string_value>,
"right": <string_value>
}
}, ...],
"dstipaddresses": [{
"excluded": <boolean_value>,
"dstipaddress": {
"rangetype": <string_value>,
"ipaddressmask": <string_value>,
"left": <string_value>,
"ipaddress": <string_value>,
"right": <string_value>
}
}, ...],
"dstethernetaddresses": [{
"excluded": <boolean_value>,
"dstetheraddress": <string_value>
}, ...]
}, ...],
"order": <integer_value>,
"name": <string_value>,
"maxbandwidthout": <long_value>,
"maxbandwidthin": <long_value>,
"linktype": <string_value>
}}

Response Headers:

Content-Type: application/vnd.com.citrix.cloudbridge.link_definition+json

Response Payload: JSON

{"link_definition":{
"enabled": <boolean_value>,
"filterrules": [{
"enabled": <boolean_value>,
"wccpservicegroups": [{
"excluded": <boolean_value>,
"groupid": <integer_value>
}, ...],
"vlans": [{
"vlanid": <integer_value>,
"excluded": <boolean_value>
}, ...],
"interfaces": [{
"excluded": <boolean_value>,
"interfacename": <string_value>
}, ...],
"srcethernetaddresses": [{
"excluded": <boolean_value>,
"srcetheraddress": <string_value>
}, ...],
"srcipaddresses": [{
"excluded": <boolean_value>,
"srcipaddress": {
"rangetype": <string_value>,
"ipaddressmask": <string_value>,
"left": <string_value>,
"ipaddress": <string_value>,
"right": <string_value>
},
}, ...],
"dstipaddresses": [{
"excluded": <boolean_value>,
"dstipaddress": {
"rangetype": <string_value>,
"ipaddressmask": <string_value>,
"left": <string_value>,
"ipaddress": <string_value>,
"right": <string_value>
},
}, ...],
"dstethernetaddresses": [{
"excluded": <boolean_value>,
"dstetheraddress": <string_value>
}, ...],
}, ...],
"order": <integer_value>,
"name": <string_value>,
"linkid": <integer_value>,
"maxbandwidthout": <long_value>,
"maxbandwidthin": <long_value>,
"propertyflags": <string_value>,
"modified": <boolean_value>,
"linktype": <string_value>
}}