Update vlan

put

https://helios.cohesity.com/v2/network/vlans/{vlanInterfaceGroupName}

Update a vlan on the cluster.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

vlanInterfaceGroupName

string

required

Vlan interface group name, it should be in interface_group_name.vlan_id format.

Body Params

Parameters to update vlan on the cluster.

allTenantAccess

boolean | null

Defaults to false

Allow vlan to be used by all tenants without explicit assignment. Set to true only when the vlan is not assigned to any tenant.

appIps

array of strings | null

Vlan IP addresses for apps.

appIps

description

string | null

Description of the vlan.

ecmpEnabled

boolean | null

Defaults to false

Set to true to enable ECMP in the vlan.

ipAddressesType

string | null

enum

Type of IP addresses. The default value is Ipv4.

Allowed:

gateway

string | null

Subnet gateway of the vlan. This can be Ipv4 or Ipv6 gateway based on the IP addresses type.

gatewayV6

string | null

Ipv6 gateway of the vlan.

subnet

string | null

IPv4 or IPv6 subnet in CIDR format i.e ip-address/prefix. Examples: IPv4 subnet'192.168.0.101/24', '10.10.1.32/27'. IPv6 subnet '3005:1231:2006:0025::0/96', 3005:1231:2006:0025::0/128

subnetV6

string | null

IPv6 subnet in CIDR format i.e ip-address/prefix

tenantId

string | null

Tenant id to assign vlan to a tenant.

interfaceName

string | null

Name of the interface.

vlanName

string | null

Name of the Vlan.

mtu

int32 | null

MTU of the vlan.

ips

array of strings | null

Vlan IP addresses, only one of ips or ipRanges parameters should be given.

ips

ipRanges

array of objects | null

Vlan IP address ranges, only one of ips or ipRanges parameters should be given.

ipRanges

fqdn

string | null

FQDN of the vlan.

ipPools

array of objects | null

IP pools from the vlan ip addresses, the IPs in a pool goes together. One IP from each pool forms a VIP group.

ipPools

dnsDelegationZones

array of objects | null

DNS delegation zones of the vlan.

dnsDelegationZones

loopbackInterfaceGroupId

int32 | null

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

Headers

accessClusterId

int64

This field uniquely represents a Cohesity Cluster and is used for making on-prem calls from Helios.

Responses

200Success

defaultError