Skip to main content
Pure1 Support Portal

puresubnet

Name

puresubnet, puresubnet-create, puresubnet-delete, puresubnet-disable, puresubnet-enable, puresubnet-list, puresubnet-rename, puresubnet-setattr — manages the subnets and VLANs used to organize the network interfaces

Synopsis

puresubnet create [--gateway GATEWAY] [--mtu MTU] --prefix PREFIX [--vlan VLAN] SUBNET

puresubnet delete SUBNET

puresubnet disable SUBNET...

puresubnet enable SUBNET...

puresubnet list [ --cli | --csv | --nvp ] [--notitle] [--page] [--raw] [--vlan VLAN] [SUBNET...]

puresubnet rename OLD-NAME NEW-NAME

puresubnet setattr [--gateway GATEWAY] [--mtu MTU] [--prefix PREFIX] [--vlan VLAN] SUBNET

Arguments

SUBNET

Subnet name.

NEW-NAME

Name by which the subnet is to be known after the command executes.

OLD-NAME

Current name of the subnet to be renamed.

Options

-h | --help

Can be used with any command or subcommand to display a brief syntax description.

--gateway GATEWAY

IP address of the gateway through which the specified interface is to communicate with the network. For IPv4, specify the gateway IP address in the form ddd.ddd.ddd.ddd. For IPv6, specify the gateway IP address in the form xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx. When specifying an IPv6 address, consecutive fields of zeros can be shortened by replacing the zeros with a double colon (::).

To remove the gateway specification, set to a null value (""). The interfaces in the subnet inherit the gateway address.

--mtu

Maximum transmission unit (MTU). The interfaces in the subnet inherit the MTU value.

--prefix PREFIX

IP address of the subnet prefix and prefix length. For IPv4, specify the subnet prefix in the form ddd.ddd.ddd.ddd/dd. For IPv6, specify the subnet prefix in the form xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx/xxx. When specifying an IPv6 address, consecutive fields of zeros can be shortened by replacing the zeros with a double colon (::).

--vlan VLAN

VLAN ID number. Specify the VLAN ID if the subnet is being created for VLAN tagging purposes. The VLAN interfaces in the subnet inherit the VLAN ID. To remove the VLAN ID, set --vlan to 0.

Options that control display format:

--cli

Displays output in the form of CLI commands that can be issued to reproduce the current configuration. The --cli output is not meaningful when combined with immutable attributes.

--csv

Lists information in comma-separated value (CSV) format. The --csv output can be used for scripting purposes and imported into spreadsheet programs.

--notitle

Lists information without column titles.

--nvp

Lists information in name-value pair (NVP) format, in the form ITEMNAME=VALUE. Argument names and information items are displayed flush left. The --nvp output is designed both for convenient viewing of what might otherwise be wide listings, and for parsing individual items for scripting purposes.

--page

Turns on interactive paging.

--raw

Displays the unformatted version of column titles and data. For example, in the purearray monitor output, the unformatted version of column title us/op (read) is usec_per_read_op. The --raw output is used to sort and filter list results.

Description

In Purity, interfaces with common attributes can be organized into subnetworks, or subnets, to enhance the efficiency of data (iSCSI), management, and replication traffic.

If the subnet is assigned a valid IP address, once it is created, all of its enabled interfaces are immediately available for connection. The subnet inherits the services from all of its interfaces. Likewise, the interfaces contained in the subnet inherit the netmask, gateway, MTU, and VLAN ID (if applicable) attributes from the subnet.

Physical, virtual, and bond interfaces can belong to the same subnet. VLAN interfaces can only belong to subnets with other VLAN interfaces.

Physical, virtual, and bond interfaces in a subnet share common address, netmask, and MTU attributes. The subnet can contain a mix of physical, virtual, and bond interfaces, and the interface services can be of any type, such as iSCSI, management, or replication services. To add physical, virtual, or bond interfaces to a subnet, create the subnet and then run purenetwork setattr --subnet to add the interfaces to the subnet.

A VLAN interface is a dedicated virtual network interface that is designed to be used with an organization’s virtual local area network (VLAN). Through VLAN interfaces, Purity employs VLAN tags to ensure the data passing between the array and VLANs is securely isolated and routed properly.

VLAN Tagging

VLAN tagging allows customers to isolate traffic through multiple virtual local area networks (VLANs), ensuring data routes to and from the appropriate networks. The array performs the work of tagging and untagging the data that passes between the VLAN and array.

VLAN is only supported for the iSCSI service type, so before creating a VLAN interface, verify the iSCSI service is configured on the physical interface.

Each port can support multiple VLANs. Note that each array supports up to 32 VLAN IDs, so if multiple hosts connect through multiple VLANs, it is possible to quickly reach the maximum number of paths that a host would support.

The puresubnet create command creates subnets.

To create and add VLAN interfaces to a subnet, first, create a subnet and assign it with a VLAN ID number, and second, create a VLAN interface for each of the corresponding physical network interfaces you want to associate with the VLAN. Run puresubnet create --prefix --vlan to create a subnet for each of the VLANs in the organization, assigning each subnet with the appropriate VLAN ID. For each of the physical network interfaces you want to associate with a VLAN, run purenetwork create vif --subnet to create a VLAN interface (vif) and add it to the subnet. Include the --address option to create a reachable VLAN interface that is ready to use. All of the VLAN interfaces within a subnet must be in the same VLAN.

In Purity, VLAN interfaces have the naming structure CTx.ETHy.z, where x denotes the controller (0 or 1), y denotes the interface (0 or 1), and z denotes the VLAN ID number. For example, ct0.eth1.500.

In the following example, subnet 192.168.100.0/24, named ESXHost001 and assigned to VLAN 50, is being created. The physical interfaces ct0.eth4 and ct0.eth5 are being added to subnet 192.168.100.0/24 (named ESXHost001) as VLAN interfaces, with VLAN ID number 50 appended to the interface name to match the VLAN ID number of the subnet.

puresubnet create --gateway 192.168.1.1 --mtu 9000 --prefix 192.168.100.0/24
                  --vlan 50 ESXHost001
purenetwork create vif --address 192.168.1.10 --subnet ESXHost001 ct0.eth4.50
purenetwork create vif --address 192.168.1.11 --subnet ESXHost001 ct0.eth5.50
    

If a physical interface has multiple VLANs, create a subnet for each VLAN, and then create the VLAN interfaces mapping the physical interface to the given VLANs.

When creating the VLAN interface, the VLAN ID number in the VLAN interface name must match the VLAN ID of the subnet. In the following example, the second command will not work because the VLAN ID number of the ESXHost002 subnet (600) does not match the VLAN ID number in the VLAN interface name (500).

puresubnet create --prefix 2001:db8:85a3::/64 --gateway 2001:0db8:85a3::1
                  --vlan 600 ESXHost002
purenetwork create vif --address 2001:0db8:85a3::ae26:8a2e:0370:7334
                       --subnet ESXHost002 ct0.eth1.500
    

If --mtu is not specified during subnet creation, the value defaults to 1500. Note that the MTU of a VLAN interface cannot exceed the MTU of the corresponding physical interface. Since an interface inherits the MTU value of its subnet, verify the MTU of the new subnet is valid.

Once a subnet is created, the interfaces within the subnet that are enabled are automatically available and ready to connect.

The puresubnet delete command deletes subnets that are no longer needed. A subnet can only be deleted if it is empty, so before you delete a subnet, remove all of its interfaces by running purenetwork delete.

The puresubnet enable and puresubnet disable commands respectively enable and disable a subnet.

When a subnet is enabled, the interfaces within the subnet that are enabled are automatically available and ready to connect. Interfaces within the subnet that are in disable status remain disabled and cannot be reached. Newly created subnets are automatically enabled.

Disabling a subnet disables all of its interfaces - including the ones that are enabled at the interface level.

Take caution when disabling a subnet. If you disable a subnet that contains interfaces through which administrative sessions are being conducted, the interfaces will lose SSH connection.

The puresubnet list command displays the attributes of the subnets, including its physical, virtual, bond, and VLAN interfaces. Include the --vlan option to list only the subnets that are configured with the specified VLAN ID.

The puresubnet rename command changes the current (OLD-NAME) name of a subnet to the new name (NEW-NAME). The name change is effective immediately and the old name is no longer recognized in CLI or GUI interactions. Renaming a subnet does not affect any of the interface connections attached to the subnet.

The puresubnet setattr subcommand modifies the subnet attributes, including subnet gateway, MTU size, prefix, and VLAN ID.

The --gateway and --mtu options can be set at any time. Note that the MTU of a VLAN interface cannot exceed the MTU of the corresponding physical interface. Since an interface inherits the MTU value of its subnet, verify the MTU is valid.

The --prefix and --vlan options can only be set if the subnet does not contain interfaces. Only specify the VLAN ID number if the subnet is being created for VLAN tagging purposes. To remove the VLAN ID from a subnet, set --vlan to 0.

Examples

Example 1

puresubnet create --prefix 192.168.1.0/24 --vlan 100 ESXHost001
      

Creates subnet ESXHost001 with prefix 192.168.1.0/24 and VLAN ID 100.

Example 2

$ puresubnet create --prefix 2001:db8:85a3::/64 --vlan 200 ESXHost002
      

Creates subnet ESXHost002 with prefix 2001:db8:85a3::/64 and VLAN ID 200.

Example 3

puresubnet delete ESXHost001
      

Deletes subnet ESXHost001. Subnets can only be deleted if they do not contain network interfaces.

Example 4

puresubnet setattr --vlan 50 ESXHost001
      

Sets subnet ESXHost001 to VLAN ID 50.

Example 5

puresubnet list --vlan 50
      

Displays only subnets set to VLAN ID 50.

See Also

purearray(1)

Author

Pure Storage Inc.