Getting StartedAPI ReferenceRecipesGitHub
API Reference

Creates a VLAN of the Cohesity Cluster.

post
https://cluster.ip.address/irisservices/api/v1/public/vlans

Privileges: VLAN_MODIFY, CLUSTER_CREATE

Returns the created VLAN on the Cohesity Cluster.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Specifies the settings of a VLAN.
Its used by both Request and Response structures.

boolean | null

Specifies whether to add the VLAN IPs to the cluster partition
that already has one or more IPs from this VLAN.

boolean | null

Specifies if this VLAN can be used by all tenants without explicit
assignment to them. This option can only be set true for VLANs that are
not assigned to any tenant.

boolean | null

Set to true when ips are in use by Athena Apps.
Note: If it is true then vlan interface can't be deleted.

appsips
array of strings | null

Array of Athena Apps IPs.

Specifies a list of Athena IPs in the VLAN.

appsips
string | null

Specifies a description of the VLAN.

dnsDelegationZones
array of objects | null

Specifies list of dns delegation zones.

dnsDelegationZones
boolean | null

EcmpEnabled.
Specifies if ECMP is enabled in the VLAN.

string | null

Specifies the Gateway of the VLAN. It can carry V4 or V6 in case of
requests, and carrises V4 in case of response.

string | null

Specifies the Gateway of the VLAN.

string | null

Specifies the hostname of the VLAN.

int32 | null

Specifies the id of the VLAN.

string | null

Specifies the interface group name of the VLAN. It is in the format of
<base_interface_group_name>.<vlan_id>.

int32 | null

Specifies the id of the Loopback Interface group. Used only in get,
for display.

string | null

Specifies the interface name of the VLAN.

int32 | null

Specifies IP family. Based on this, subnet/gateway field contains
V4 or V6 values. Used in Request.

ipPoolMap
object | null

IpPoolMap.

Pool IPs to program VIP followers.

ipRange
object | null

IP Range for vip addition

ipRanges
array of objects | null

Array of range of ips.
If specified in PUT request, Ips field will be ignored.
Specifies ips in compressed way using list of [start, end] vips.

ipRanges
ips
array of strings | null

Array of IPs.

Specifies a list of IPs in the VLAN.

ips
int32 | null
staticVips
array of objects | null

Static Vips

staticVips
subnet
object | null

Specifies the subnet of the VLAN.
The netmask can be specified by setting netmaskBits or netmaskIp4.
The netmask can only be set using netmaskIp4 if the IP address is
an IPv4 address. It can carry V4 or V6 in case of requests, and carries
V4 in case of response.

subnetV6
object | null

Specifies the subnet of the VLAN.
The netmask can be specified by setting netmaskBits or netmaskIp4.
The netmask can only be set using netmaskIp4 if the IP address is
an IPv4 address.

string | null

Optional tenant id that this vlan belongs to.

string | null

Specifies the VLAN name of the vlanId.

Responses

Updated about 5 hours ago

Did this page help you?
Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 5 hours ago

Did this page help you?