Puppet Task: network_modify
- Defined in:
-
tasks/network_modify.json,
tasks/network_modify.rb
Overview
Modify IP network parameters, such as gateways, netmasks, VLAN identifiers, and IP addresses.
Supports noop? false
Parameters
- add_addresses (Optional[Array[String]]) — IP addresses to add in IPv4 or IPv6 format.
- cluster_mgmt_address (Optional[String]) — New cluster management IP address in IPv4 or IPv6 format, corresponding to the network's IP version.This can only be specified when reconfiguring the management network.Caution: Changing the cluster management IP address will lead to losing management sessions through this address.
- esxi_credentials (Optional[Array[Struct[{Optional[node_id] => Optional[String], Optional[password] => Optional[String], }]]]) — Credentials required for re-registering the ESXi hosts in the vCenter.Should be passed only when ESXi host addresses or management network VLAN / prefix / gateway are changedduring the reconfiguration of the PowerStore X model appliances.
- force (Optional[Boolean]) — Indicates whether to suppress network validation errors.The option is intended to suppress false errors caused by network environment constraints.Normally the command will fail with an error when:- some of system network ports are in degraded state or have cabling issues,- system top-of-rack switches have configuration issues leading to network unreachability,- network IP addresses have duplicates in the network environment,- or network gateway is unreachable.When force is true, the command will proceed instead.Caution: Only use this option when you are certain your requested settings are correct and you understand why they are failing at this time, and you want to apply the settings anyway.Improper network settings can make the system unreachable for data and management.
- gateway (Optional[String]) — Network gateway in IPv4 or IPv6 format, corresponding to the network's IP version.Specify empty string to remove the gateway.
- id (String) — Unique identifier of the IP network.
- mtu (Optional[Integer[1280,9000]]) — Maximum Transmission Unit (MTU) packet size set on network interfaces, in bytes.
- prefix_length (Optional[Integer[1,127]]) — Network prefix length. (Used for both IPv4 and IPv6).
- remove_addresses (Optional[Array[String]]) — IP addresses to remove in IPv4 or IPv6 format.
- storage_discovery_address (Optional[String]) — New storage discovery IP address in IPv4 or IPv6 format, corresponding to the network's IP version.This can only be specified when reconfiguring the storage network.Specify empty string to remove the storage discovery IP address.
- vasa_provider_credentials (Optional[Struct[{Optional[password] => Optional[String], Optional[username] => Optional[String], }]]) — Credentials required for re-registering the VASA vendor provider during the reconfiguration of the cluster management IP address.Should be passed only when reconfiguring cluster management IP address.
- vlan_id (Optional[Integer[0,4094]]) — VLAN identifier.