network interface modify
Modify a logical interface
Availability: This command is available to cluster administrators at the admin privilege level.
Description
The network interface modify
command modifies attributes of a logical interface (LIF).
You cannot modify some properties of an iSCSI or FCP LIF, such as -home-node or -home-port , if the LIF is in a portset. To modify these properties, first remove the LIF from the portset. To determine if a LIF is in a portset, use the lun portset show command. To remove the LIF from the portset, use the lun portset remove command.
|
On some cloud platforms, this operation might perform changes to the external route tables. |
Parameters
-vserver <vserver>
- Vserver Name-
Use this parameter to specify the Vserver on which the LIF to be modified is located.
-lif <lif-name>
- Logical Interface Name-
Use this parameter to specify the name of the LIF that is to be modified
[-service-policy <text>]
- Service Policy-
Use this parameter to modify the service policy associated with the LIF.
[-address <IP Address>]
- Network Address-
Use this parameter to modify the LIF's IP address.
A cluster LIF cannot be on the same subnet as a data or management LIF. - {
[-netmask <IP Address>]
- Netmask -
Use this parameter to modify the LIF's netmask.
- |
[-netmask-length <integer>]
- Bits in the Netmask -
Use this parameter to modify the length (in bits) of the LIF's netmask.
- |
[-subnet-name <subnet name>]
- Subnet Name } -
Use this parameter to allocate the interface address from a subnet. Modifying this parameter will cause a new IP address to be allocated and assigned to the interface.
[-home-node <nodename>]
- Home Node-
Use this parameter to modify the LIF's home node. The home node is the node to which the LIF returns when the network interface revert command is run on that LIF.
[-home-port {<netport>|<ifgrp>}]
- Home Port-
Use this parameter to modify the LIF's home port. The home port is the port or interface group to which the LIF returns when the network interface revert command is run on that LIF.
[-status-admin {up|down}]
- Administrative Status-
Use this parameter to modify the administrative status of the LIF. The administrative status can differ from the operational status. For example, if you specify the status as
up
but a network problem prevents the interface from functioning, the operational status remains asdown
. [-failover-policy {system-defined|local-only|sfo-partner-only|disabled|broadcast-domain-wide}]
- Failover Policy-
Use this parameter to modify the failover policy for the LIF.
-
system-defined - The system determines appropriate failover targets for the LIF. The default behavior is that failover targets are chosen from the LIF's current hosting node and also from one other non-partner node when possible.
-
local-only - The LIF fails over to a port on the local or home node of the LIF.
-
sfo-partner-only - The LIF fails over to a port on the home node or SFO partner only.
-
broadcast-domain-wide - The LIF fails over to a port in the same broadcast domain as the home port.
-
disabled - Failover is disabled for the LIF.
The failover policy for cluster logical interfaces is local-only and cannot be changed. The default failover policy for data logical interfaces is system-defined. This value can be changed. -
[-firewall-policy <policy>]
- (DEPRECATED)-Firewall Policy-
This parameter has been deprecated and may be removed in a future version of ONTAP. Use the -service-policy
parameter instead.Use this parameter to set the firewall policy for the LIF. A LIF can use a default firewall policy that corresponds to its role (management, cluster, or data) or a custom firewall policy created by an administrator. When using a custom policy, the interface will fallback on its role's default policy for unspecified services. View existing firewall policies with the "system services firewall policy show " command. Modify existing firewall policies with the "system services firewall policy modify " command.
The NFS data protocol relies on firewall services included in the built-in "data" and "mgmt-nfs" firewall policies. Assigning a different firewall policy policy might disrupt some NFS client implementations. [-auto-revert {true|false}]
- Auto Revert-
Use this parameter to modify whether a data LIF is reverted automatically to its home port under certain circumstances. These circumstances would include startup, when the status of the management database changes to either master or secondary, and when the network connection is made.
[-dns-zone {<zone-name>|none}]
- Fully Qualified DNS Zone Name-
Use this parameter to modify the unique, fully qualified domain name of the DNS zone to which this data LIF belongs. You can associate a data LIF with a single DNS zone. All data LIFs included in a zone must be on the same Vserver. If you do not specify a value for this parameter, the data LIF is created with the value
none
. [-listen-for-dns-query {true|false}]
- DNS Query Listen Enable-
Use this parameter to specify if the LIF has to listen for DNS queries. The default value for this parameter is true.
[-allow-lb-migrate {true|false}]
- (DEPRECATED)-Load Balancing Migrate Allowed (privilege: advanced)-
This parameter has been deprecated and may be removed in a future version of ONTAP. Use this parameter to modify whether or not load balancing migration is enabled for this data LIF. The default value of this parameter is
false
. If you set the value of this parameter totrue
, the automatic revert capability of the data LIF is disabled (the-auto-revert
parameter is set tofalse
). Also, data LIFs that migrate as a result of load balancing adhere to network interface failover rules.During times when a LIF is hosting active NFSv4, CIFS, or NRV connections, load balancing based LIF migrations between nodes will be temporarily disabled. [-lb-weight {load|0..100}]
- Load Balanced Weight (privilege: advanced)-
Use this parameter to modify the load balancing weight of the data LIF. A valid load balancing weight is any integer between 1 and 100. If you specify the same load balancing weight for all data LIFs in a DNS zone, client requests are uniformly distributed, similar to round-robin DNS. A data LIF with a low load balancing weight is made available for client requests less frequently than one that has a high load balancing weight.
[-failover-group <failover-group>]
- Failover Group Name-
Use this parameter to modify the name of the failover group to associate with the network interface. Manage failover groups using the
network interface failover-groups
command. Each broadcast domain has a default failover group which is created by the system automatically and has the same name as the broadcast domain. The failover group associated with the broadcast domain includes all ports in the broadcast domain. A logical interface's failover group is set to the failover group of the home port's broadcast domain by default, but this value can be modified. [-comment <text>]
- Comment-
Use this parameter to modify the comment associated with the LIF.
[-force-subnet-association <true>]
- Force the LIF's Subnet Association-
This command will fail if the IP address falls within the address range of a named subnet. Set this to true to acquire the address from the named subnet and assign the subnet to the LIF.
[-is-dns-update-enabled {true|false}]
- Is Dynamic DNS Update Enabled?-
If this parameter is set to
true
, then dynamic DNS update is sent to the DNS server for the particular LIF entry if dynamic DNS updates are enabled for the corresponding Vserver. This field is set totrue
by default for both IPv4 and IPv6 LIFs. DNS Update is not supported on LIFs not configured with either the NFS or CIFS protocol. [-rdma-protocols <roce>,…]
- Required RDMA offload protocols-
Defines RDMA offload protocols required by the LIF. A non-empty list will ensure that this LIF can only be moved to network ports that support the specified RDMA offload protocols.
Examples
The following example modifies a LIF named datalif1 on a logical server named vs0. The LIF's netmask is modified to 255.255.255.128.
cluster1::> network interface modify -vserver vs0 -lif datalif1 -netmask 255.255.255.128