Skip to content

Commit

Permalink
Address doc comments
Browse files Browse the repository at this point in the history 
Signed-off-by: graysonwu <[email protected]>
  • Loading branch information
@GraysonWu
GraysonWu committed Aug 21, 2023
1 parent 8b6d473 commit ca4fbba
Showing 1 changed file with 23 additions and 24 deletions.
47 changes: 23 additions & 24 deletions website/docs/r/uplink_host_switch_profile.html.markdown
View file
Original file line number Diff line number Diff line change
Expand Up @@ -75,32 +75,32 @@ The following arguments are supported:
* `description` - (Optional) Description of the resource.
* `tag` - (Optional) A list of scope + tag pairs to associate with this resource.
* `nsx_id` - (Optional) The NSX ID of this resource. If set, this ID will be used to create the resource.
* `mtu` - (Optional) Maximum Transmission Unit used for uplinks format: int32, minimum: 1280.
* `transport_vlan` - (Optional) VLAN used for tagging Overlay traffic of associated HostSwitch format: int64. Default: 0
* `overlay_encap` - (Optional) The protocol used to encapsulate overlay traffic. Possible values are: VXLAN, GENEVE. Default: GENEVE.
* `mtu` - (Optional) Maximum Transmission Unit used for uplinks. Minimum: 1280.
* `transport_vlan` - (Optional) VLAN used for tagging Overlay traffic of associated HostSwitch. Default: 0.
* `overlay_encap` - (Optional) The protocol used to encapsulate overlay traffic. Possible values are: `VXLAN`, `GENEVE`. Default: `GENEVE`.
* `lag` - (Optional) List of LACP group.
* `load_balance_algorithm` - (Required) LACP load balance Algorithm. Possible values are: SRCMAC, DESTMAC, SRCDESTMAC, SRCDESTIPVLAN, SRCDESTMACIPPORT.
* `mode` - (Required) LACP group mode. Possible values are: ACTIVE, PASSIVE.
* `load_balance_algorithm` - (Required) LACP load balance Algorithm. Possible values are: `SRCMAC`, `DESTMAC`, `SRCDESTMAC`, `SRCDESTIPVLAN`, `SRCDESTMACIPPORT`.
* `mode` - (Required) LACP group mode. Possible values are: `ACTIVE`, `PASSIVE`.
* `name` - (Required) Lag name.
* `number_of_uplinks` - (Required) Number of uplinks format: int32, minimum: 2, maximum: 32.
* `timeout_type` - (Optional) LACP timeout type. Possible values are: SLOW, FAST. Default: SLOW
* `number_of_uplinks` - (Required) Number of uplinks. Minimum: 2, maximum: 32.
* `timeout_type` - (Optional) LACP timeout type. Possible values are: `SLOW`, `FAST`. Default: `SLOW`.
* `teaming` - (Required) Default TeamingPolicy associated with this UplinkProfile.
* `active` - (Required) List of Uplinks used in active list
* `uplink_name` - (Required) Name of this uplink
* `uplink_type` - (Required) Type of the uplink. Possible values are: PNIC, LAG.
* `policy` - (Required) Teaming policy. Possible values are: FAILOVER_ORDER, LOADBALANCE_SRCID, LOADBALANCE_SRC_MAC.
* `standby` - (Optional) List of Uplinks used in standby list
* `uplink_name` - (Required) Name of this uplink
* `uplink_type` - (Required) Type of the uplink. Possible values are: PNIC, LAG.
* `named_teaming` - (Optional) List of named uplink teaming policies that can be used by logical switches
* `active` - (Required) List of Uplinks used in active list
* `uplink_name` - (Required) Name of this uplink
* `uplink_type` - (Required) Type of the uplink. Possible values are: PNIC, LAG.
* `policy` - (Required) Teaming policy. Possible values are: FAILOVER_ORDER, LOADBALANCE_SRCID, LOADBALANCE_SRC_MAC.
* `standby` - (Optional) List of Uplinks used in standby list
* `uplink_name` - (Required) Name of this uplink
* `uplink_type` - (Required) Type of the uplink. Possible values are: PNIC, LAG.
* `name` - (Optional) An uplink teaming policy of a given name defined in UplinkHostSwitchProfile. The names of all NamedTeamingPolicies in an UplinkHostSwitchProfile must be different, but a name can be shared by different UplinkHostSwitchProfiles. Different TransportNodes can use different NamedTeamingPolicies having the same name in different UplinkHostSwitchProfiles to realize an uplink teaming policy on a logical switch. An uplink teaming policy on a logical switch can be any policy defined by a user; it does not have to be a single type of FAILOVER or LOADBALANCE. It can be a combination of types, for instance, a user can define a policy with name \"MyHybridTeamingPolicy\" as \"FAILOVER on all ESX TransportNodes and LOADBALANCE on all KVM TransportNodes\".
* `active` - (Required) List of Uplinks used in active list.
* `uplink_name` - (Required) Name of this uplink.
* `uplink_type` - (Required) Type of the uplink. Possible values are: `PNIC`, `LAG`.
* `policy` - (Required) Teaming policy. Possible values are: `FAILOVER_ORDER`, `LOADBALANCE_SRCID`, `LOADBALANCE_SRC_MAC`.
* `standby` - (Optional) List of Uplinks used in standby list.
* `uplink_name` - (Required) Name of this uplink.
* `uplink_type` - (Required) Type of the uplink. Possible values are: `PNIC`, `LAG`.
* `named_teaming` - (Optional) List of named uplink teaming policies that can be used by logical switches.
* `active` - (Required) List of Uplinks used in active list.
* `uplink_name` - (Required) Name of this uplink.
* `uplink_type` - (Required) Type of the uplink. Possible values are: `PNIC`, `LAG`.
* `policy` - (Required) Teaming policy. Possible values are: `FAILOVER_ORDER`, `LOADBALANCE_SRCID`, `LOADBALANCE_SRC_MAC`.
* `standby` - (Optional) List of Uplinks used in standby list.
* `uplink_name` - (Required) Name of this uplink.
* `uplink_type` - (Required) Type of the uplink. Possible values are: `PNIC`, `LAG`.
* `name` - (Optional) An uplink teaming policy of a given name defined in UplinkHostSwitchProfile. The names of all NamedTeamingPolicies in an UplinkHostSwitchProfile must be different, but a name can be shared by different UplinkHostSwitchProfiles. Different TransportNodes can use different NamedTeamingPolicies having the same name in different UplinkHostSwitchProfiles to realize an uplink teaming policy on a logical switch. An uplink teaming policy on a logical switch can be any policy defined by a user; it does not have to be a single type of FAILOVER or LOADBALANCE. It can be a combination of types, for instance, a user can define a policy with name `MyHybridTeamingPolicy` as `FAILOVER on all ESX TransportNodes and LOADBALANCE on all KVM TransportNodes`.

## Attributes Reference

Expand All @@ -127,4 +127,3 @@ The above command imports UplinkHostSwitchProfile named `uplink_host_switch_prof
terraform import nsxt_uplink_host_switch_profile.uplink_host_switch_profile POLICY_PATH
```
The above command imports the uplink host switch profile named `uplink_host_switch_profile` with policy path `POLICY_PATH`.
Note: for multitenancy projects only the later form is usable.

0 comments on commit ca4fbba

Please sign in to comment.