com.solidfire.element.api

Class ModifyVirtualNetworkRequest

java.lang.Object

com.solidfire.element.api.ModifyVirtualNetworkRequest

All Implemented Interfaces:

java.io.Serializable

public class ModifyVirtualNetworkRequest
extends java.lang.Object
implements java.io.Serializable

ModifyVirtualNetworkRequest You can use ModifyVirtualNetwork to change the attributes of an existing virtual network. This method enables you to add or remove address blocks, change the netmask, or modify the name or description of the virtual network. You can also use it to enable or disable namespaces, as well as add or remove a gateway if namespaces are enabled on the virtual network. Note: This method requires either the VirtualNetworkID or the VirtualNetworkTag as a parameter, but not both. Caution: Enabling or disabling the Routable Storage VLANs functionality for an existing virtual network by changing the "namespace" parameter disrupts any traffic handled by the virtual network. NetApp strongly recommends changing the "namespace" parameter only during a scheduled maintenance window.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ModifyVirtualNetworkRequest.Builder

Field Summary

Fields

Modifier and Type	Field and Description
static long	serialVersionUID

Constructor Summary

Constructors

Constructor and Description
ModifyVirtualNetworkRequest()
ModifyVirtualNetworkRequest(Optional<java.lang.Long> virtualNetworkID, Optional<java.lang.Long> virtualNetworkTag, Optional<java.lang.String> name, Optional<AddressBlockParams[]> addressBlocks, Optional<java.lang.String> netmask, Optional<java.lang.String> svip, Optional<Attributes> attributes)
ModifyVirtualNetworkRequest(Optional<java.lang.Long> virtualNetworkID, Optional<java.lang.Long> virtualNetworkTag, Optional<java.lang.String> name, Optional<AddressBlockParams[]> addressBlocks, Optional<java.lang.String> netmask, Optional<java.lang.String> svip, Optional<java.lang.String> gateway, Optional<java.lang.Boolean> namespace, Optional<Attributes> attributes)

Method Summary

Modifier and Type	Method and Description
ModifyVirtualNetworkRequest.Builder	asBuilder()
static ModifyVirtualNetworkRequest.Builder	builder()
boolean	equals(java.lang.Object o)
Optional<AddressBlockParams[]>	getAddressBlocks() The new addressBlock to set for this virtual network.
Optional<Attributes>	getAttributes() A new list of name-value pairs in JSON object format.
Optional<java.lang.String>	getGateway() The IP address of a gateway of the virtual network.
Optional<java.lang.String>	getName() The new name for the virtual network.
Optional<java.lang.Boolean>	getNamespace() When set to true, enables the Routable Storage VLANs functionality by recreating the virtual network and configuring a namespace to contain it.
Optional<java.lang.String>	getNetmask() New network mask for this virtual network.
Optional<java.lang.String>	getSvip() The storage virtual IP address for this virtual network.
Optional<java.lang.Long>	getVirtualNetworkID() The unique identifier of the virtual network to modify.
Optional<java.lang.Long>	getVirtualNetworkTag() The network tag that identifies the virtual network to modify.
int	hashCode()
void	setAddressBlocks(Optional<AddressBlockParams[]> addressBlocks)
void	setAttributes(Optional<Attributes> attributes)
void	setGateway(Optional<java.lang.String> gateway)
void	setName(Optional<java.lang.String> name)
void	setNamespace(Optional<java.lang.Boolean> namespace)
void	setNetmask(Optional<java.lang.String> netmask)
void	setSvip(Optional<java.lang.String> svip)
void	setVirtualNetworkID(Optional<java.lang.Long> virtualNetworkID)
void	setVirtualNetworkTag(Optional<java.lang.Long> virtualNetworkTag)
java.util.Map<java.lang.String,java.lang.Object>	toMap()
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

serialVersionUID

public static final long serialVersionUID

See Also:

Constant Field Values

Constructor Detail

ModifyVirtualNetworkRequest

@Since(value="7.0")
public ModifyVirtualNetworkRequest()

ModifyVirtualNetworkRequest

@Since(value="7.0")
public ModifyVirtualNetworkRequest(Optional<java.lang.Long> virtualNetworkID,
                                                       Optional<java.lang.Long> virtualNetworkTag,
                                                       Optional<java.lang.String> name,
                                                       Optional<AddressBlockParams[]> addressBlocks,
                                                       Optional<java.lang.String> netmask,
                                                       Optional<java.lang.String> svip,
                                                       Optional<Attributes> attributes)

ModifyVirtualNetworkRequest

@Since(value="9.0")
public ModifyVirtualNetworkRequest(Optional<java.lang.Long> virtualNetworkID,
                                                       Optional<java.lang.Long> virtualNetworkTag,
                                                       Optional<java.lang.String> name,
                                                       Optional<AddressBlockParams[]> addressBlocks,
                                                       Optional<java.lang.String> netmask,
                                                       Optional<java.lang.String> svip,
                                                       Optional<java.lang.String> gateway,
                                                       Optional<java.lang.Boolean> namespace,
                                                       Optional<Attributes> attributes)

Method Detail

getVirtualNetworkID

public Optional<java.lang.Long> getVirtualNetworkID()

The unique identifier of the virtual network to modify. This is the virtual network ID assigned by the cluster. Note: This parameter is optional but either virtualNetworkID or virtualNetworkTag must be specified with this API method.

setVirtualNetworkID

public void setVirtualNetworkID(Optional<java.lang.Long> virtualNetworkID)

getVirtualNetworkTag

public Optional<java.lang.Long> getVirtualNetworkTag()

The network tag that identifies the virtual network to modify. Note: This parameter is optional but either virtualNetworkID or virtualNetworkTag must be specified with this API method.

setVirtualNetworkTag

public void setVirtualNetworkTag(Optional<java.lang.Long> virtualNetworkTag)

getName

public Optional<java.lang.String> getName()

The new name for the virtual network.

setName

public void setName(Optional<java.lang.String> name)

getAddressBlocks

public Optional<AddressBlockParams[]> getAddressBlocks()

The new addressBlock to set for this virtual network. This might contain new address blocks to add to the existing object or omit unused address blocks that need to be removed. Alternatively, you can extend or reduce the size of existing address blocks. You can only increase the size of the starting addressBlocks for a virtual network object; you can never decrease it. Attributes for this parameter are: start: The start of the IP address range. (String) size: The number of IP addresses to include in the block. (Integer)

setAddressBlocks

public void setAddressBlocks(Optional<AddressBlockParams[]> addressBlocks)

getNetmask

public Optional<java.lang.String> getNetmask()

New network mask for this virtual network.

setNetmask

public void setNetmask(Optional<java.lang.String> netmask)

getSvip

public Optional<java.lang.String> getSvip()

The storage virtual IP address for this virtual network. The svip for a virtual network cannot be changed. You must create a new virtual network to use a different svip address.

setSvip

public void setSvip(Optional<java.lang.String> svip)

getGateway

public Optional<java.lang.String> getGateway()

The IP address of a gateway of the virtual network. This parameter is valid only if the namespace parameter is set to true (meaning VRF is enabled).

setGateway

public void setGateway(Optional<java.lang.String> gateway)

getNamespace

public Optional<java.lang.Boolean> getNamespace()

When set to true, enables the Routable Storage VLANs functionality by recreating the virtual network and configuring a namespace to contain it. When set to false, disables the VRF functionality for the virtual network. Changing this value disrupts traffic running through this virtual network.

setNamespace

public void setNamespace(Optional<java.lang.Boolean> namespace)

getAttributes

public Optional<Attributes> getAttributes()

A new list of name-value pairs in JSON object format.

setAttributes

public void setAttributes(Optional<Attributes> attributes)

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toMap

public java.util.Map<java.lang.String,java.lang.Object> toMap()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

builder

public static ModifyVirtualNetworkRequest.Builder builder()

asBuilder

public final ModifyVirtualNetworkRequest.Builder asBuilder()