vcf_vim_host_network

Execution module for standard vSwitch / port group / VMkernel (SOAP).

saltext.vcf.modules.vcf_vim_host_network.vswitch_list(host, profile=None)

List standard vSwitches on the host.

CLI Example:

salt '*' vcf_vim_host_network.vswitch_list esxi-01

saltext.vcf.modules.vcf_vim_host_network.vswitch_get(host, name, profile=None)

Return one vSwitch.

CLI Example:

salt '*' vcf_vim_host_network.vswitch_get esxi-01 vSwitch0

saltext.vcf.modules.vcf_vim_host_network.vswitch_get_or_none(host, name, profile=None)

Return one vSwitch or None.

CLI Example:

salt '*' vcf_vim_host_network.vswitch_get_or_none esxi-01 vSwitch1

saltext.vcf.modules.vcf_vim_host_network.vswitch_add(host, name, num_ports=128, mtu=1500, pnic_devices=None, profile=None)

Add a standard vSwitch.

CLI Example:

salt '*' vcf_vim_host_network.vswitch_add esxi-01 vSwitch1 pnic_devices='["vmnic1"]'

saltext.vcf.modules.vcf_vim_host_network.vswitch_update(host, name, num_ports=None, mtu=None, pnic_devices=None, profile=None)

Update a vSwitch.

CLI Example:

salt '*' vcf_vim_host_network.vswitch_update esxi-01 vSwitch1 mtu=9000

saltext.vcf.modules.vcf_vim_host_network.vswitch_remove(host, name, profile=None)

Remove a vSwitch.

CLI Example:

salt '*' vcf_vim_host_network.vswitch_remove esxi-01 vSwitch1

saltext.vcf.modules.vcf_vim_host_network.portgroup_list(host, profile=None)

List standard port groups.

CLI Example:

salt '*' vcf_vim_host_network.portgroup_list esxi-01

saltext.vcf.modules.vcf_vim_host_network.portgroup_get(host, name, profile=None)

Return one port group.

CLI Example:

salt '*' vcf_vim_host_network.portgroup_get esxi-01 Management

saltext.vcf.modules.vcf_vim_host_network.portgroup_get_or_none(host, name, profile=None)

Return one port group or None.

CLI Example:

salt '*' vcf_vim_host_network.portgroup_get_or_none esxi-01 NotThere

saltext.vcf.modules.vcf_vim_host_network.portgroup_add(host, name, vswitch, vlan_id=0, profile=None)

Add a standard port group.

CLI Example:

salt '*' vcf_vim_host_network.portgroup_add esxi-01 Mgmt vSwitch0 vlan_id=10

saltext.vcf.modules.vcf_vim_host_network.portgroup_update(host, name, vlan_id=None, vswitch=None, profile=None)

Update a standard port group.

CLI Example:

salt '*' vcf_vim_host_network.portgroup_update esxi-01 Mgmt vlan_id=20

saltext.vcf.modules.vcf_vim_host_network.portgroup_remove(host, name, profile=None)

Remove a standard port group.

CLI Example:

salt '*' vcf_vim_host_network.portgroup_remove esxi-01 Mgmt

saltext.vcf.modules.vcf_vim_host_network.vmkernel_list(host, profile=None)

List VMkernel adapters.

CLI Example:

salt '*' vcf_vim_host_network.vmkernel_list esxi-01

saltext.vcf.modules.vcf_vim_host_network.vmkernel_get(host, device, profile=None)

Return one VMkernel adapter.

CLI Example:

salt '*' vcf_vim_host_network.vmkernel_get esxi-01 vmk0

saltext.vcf.modules.vcf_vim_host_network.vmkernel_get_or_none(host, device, profile=None)

Return one VMkernel adapter or None.

CLI Example:

salt '*' vcf_vim_host_network.vmkernel_get_or_none esxi-01 vmk99

saltext.vcf.modules.vcf_vim_host_network.vmkernel_add(host, portgroup, dhcp=False, ip_address=None, subnet_mask=None, mtu=1500, mac_address=None, nic_types=None, profile=None)

Add a VMkernel adapter; returns the new device name (e.g. vmk1).

CLI Example:

salt '*' vcf_vim_host_network.vmkernel_add esxi-01 vMotion ip_address=10.0.0.5 subnet_mask=255.255.255.0 nic_types='["vmotion"]'

saltext.vcf.modules.vcf_vim_host_network.vmkernel_update(host, device, dhcp=None, ip_address=None, subnet_mask=None, mtu=None, profile=None)

Update a VMkernel adapter.

CLI Example:

salt '*' vcf_vim_host_network.vmkernel_update esxi-01 vmk1 mtu=9000

saltext.vcf.modules.vcf_vim_host_network.vmkernel_remove(host, device, profile=None)

Remove a VMkernel adapter.

CLI Example:

salt '*' vcf_vim_host_network.vmkernel_remove esxi-01 vmk1

saltext.vcf.modules.vcf_vim_host_network.vmkernel_set_traffic_types(host, device, nic_types, profile=None)

Replace the traffic-type list on a VMkernel adapter.

CLI Example:

salt '*' vcf_vim_host_network.vmkernel_set_traffic_types esxi-01 vmk1 '["vmotion","provisioning"]'

saltext.vcf.modules.vcf_vim_host_network.physical_nic_list(host, profile=None)

List physical NICs (pNICs) on the host.

CLI Example:

salt '*' vcf_vim_host_network.physical_nic_list esxi-01

saltext.vcf.modules.vcf_vim_host_network.vmkernel_migrate(host, device, dst_portgroup, profile=None)

Move a VMkernel adapter to a different portgroup.

CLI Example:

salt '*' vcf_vim_host_network.vmkernel_migrate <host> vmk2 <dst_portgroup>

saltext.vcf.modules.vcf_vim_host_network.ipv6_get(host, profile=None)

Return IPv6 enable state for host.

CLI Example:

salt '*' vcf_vim_host_network.ipv6_get <host>

saltext.vcf.modules.vcf_vim_host_network.ipv6_set(host, enabled, profile=None)

Enable or disable IPv6 on host. Reboot required to take effect.

CLI Example:

salt '*' vcf_vim_host_network.ipv6_set <host> True