Skip to content

Commit

Permalink
Merge pull request #872 from vmware/fix-double-nesting-docs
Browse files Browse the repository at this point in the history 
Fix double nesting issue in docs
  • Loading branch information
@annakhm
annakhm authored Apr 17, 2023
2 parents 0ac9163 + 3f93a24 commit c2b2b3d
Show file tree
Hide file tree
Showing 6 changed files with 41 additions and 41 deletions.
2 changes: 1 addition & 1 deletion nsxt/resource_nsxt_policy_group.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@ func getIPAddressExpressionSchema() *schema.Resource {
"ip_addresses": {
Type: schema.TypeSet,
Required: true,
Description: "List of; single IP addresses, IP address ranges or Subnets. Cannot mix IPv4 and IPv6 in a single list",
Description: "List of single IP addresses, IP address ranges or Subnets. Cannot mix IPv4 and IPv6 in a single list",
Elem: &schema.Schema{
Type: schema.TypeString,
ValidateFunc: validateCidrOrIPOrRange(),
Expand Down
12 changes: 6 additions & 6 deletions website/docs/r/policy_fixed_segment.html.markdown
View file
Original file line number Diff line number Diff line change
Expand Up @@ -65,20 +65,20 @@ The following arguments are supported:
* `dns_servers` - (Optional) List of IP addresses of DNS servers for the subnet.
* `lease_time` - (Optional) DHCP lease time in seconds.
* `dhcp_option_121` - (Optional) DHCP classless static routes.
* `network` - (Required) Destination in cidr format.
* `next_hop` - (Required) IP address of next hop.
* `network` - (Required) Destination in cidr format.
* `next_hop` - (Required) IP address of next hop.
* `dhcp_generic_option` - (Optional) Generic DHCP options.
* `code` - (Required) DHCP option code. Valid values are from 0 to 255.
* `values` - (Required) List of DHCP option values.
* `code` - (Required) DHCP option code. Valid values are from 0 to 255.
* `values` - (Required) List of DHCP option values.
* `dhcp_v6_config` - (Optional) DHCPv6 config for IPv6 subnet. This clause is supported with NSX 3.0.0 onwards.
* `server_address` - (Optional) IP address of the DHCP server in CIDR format. This attribute is required if segment has provided dhcp_config_path and it represents a DHCP server config.
* `dns_servers` - (Optional) List of IP addresses of DNS servers for the subnet.
* `lease_time` - (Optional) DHCP lease time in seconds.
* `preferred_time` - (Optional) The time interval in seconds, in which the prefix is advertised as preferred.
* `domain_names` - (Optional) List of domain names for this subnet.
* `excluded_range` - (Optional) List of excluded address ranges to define dynamic ip allocation ranges.
* `start` - (Required) IPv6 address that marks beginning of the range.
* `end` - (Required) IPv6 address that marks end of the range.
* `start` - (Required) IPv6 address that marks beginning of the range.
* `end` - (Required) IPv6 address that marks end of the range.
* `sntp_servers` - (Optional) IPv6 address of SNTP servers for the subnet.
* `l2_extension` - (Optional) Configuration for extending Segment through L2 VPN.
* `l2vpn_paths` - (Optional) Policy paths of associated L2 VPN sessions.
Expand Down
26 changes: 13 additions & 13 deletions website/docs/r/policy_group.html.markdown
View file
Original file line number Diff line number Diff line change
Expand Up @@ -164,27 +164,27 @@ The following arguments are supported:
* `nsx_id` - (Optional) The NSX ID of this resource. If set, this ID will be used to create the group resource.
* `criteria` - (Optional) A repeatable block to specify criteria for members of this Group. If more than 1 criteria block is specified, it must be separated by a `conjunction`. In a `criteria` block the following membership selection expressions can be used:
* `ipaddress_expression` - (Optional) An expression block to specify individual IP Addresses, ranges of IP Addresses or subnets for this Group.
* `ip_addresses` - (Required) This list can consist of a single IP address, IP address range or a subnet. Its type can be of either IPv4 or IPv6. Both IPv4 and IPv6 addresses within one expression is not allowed.
* `ip_addresses` - (Required) This list can consist of a single IP address, IP address range or a subnet. Its type can be of either IPv4 or IPv6. Both IPv4 and IPv6 addresses within one expression is not allowed.
* `macaddress_expression` - (Optional) An expression block to specify individual MAC Addresses for this Group.
* `mac_addresses` - (Required) List of MAC addresses.
* `mac_addresses` - (Required) List of MAC addresses.
* `path_expression` - (Optional) An expression block to specify direct group members by policy path.
* `member_paths` - (Required) List of policy paths for direct members for this Group (such as Segments, Segment ports, Groups etc).
* `member_paths` - (Required) List of policy paths for direct members for this Group (such as Segments, Segment ports, Groups etc).
* `external_id_expression` - (Optional) An expression block to specify external IDs for the specified member type for this Group.
* `member_type` - (Optional) External ID member type. Must be one of: `VirtualMachine`, `VirtualNetworkInterface`, `CloudNativeServiceInstance`, or `PhysicalServer`. Defaults to `VirtualMachine`.
* `external_ids` - (Required) List of external IDs for the specified member type.
* `member_type` - (Optional) External ID member type. Must be one of: `VirtualMachine`, `VirtualNetworkInterface`, `CloudNativeServiceInstance`, or `PhysicalServer`. Defaults to `VirtualMachine`.
* `external_ids` - (Required) List of external IDs for the specified member type.
* `condition` (Optional) A repeatable condition block to select this Group's members. When multiple `condition` blocks are used in a single `criteria` they form a nested expression that's implicitly ANDed together and each nested condition must used the same `member_type`.
* `key` (Required) Specifies the attribute to query. Must be one of: `Tag`, `ComputerName`, `OSName` or `Name`. For a `member_type` other than `VirtualMachine`, only the `Tag` key is supported.
* `member_type` (Required) Specifies the type of resource to query. Must be one of: `IPSet`, `LogicalPort`, `LogicalSwitch`, `Segment`, `SegmentPort` or `VirtualMachine`.
* `operator` (Required) Specifies the query operator to use. Must be one of: `CONTAINS`, `ENDSWITH`, `EQUALS`, `NOTEQUALS` or `STARTSWITH`.
* `value` (Required) User specified string value to use in the query. For `Tag` criteria, use 'scope|value' notation if you wish to specify scope in criteria.
* `key` (Required) Specifies the attribute to query. Must be one of: `Tag`, `ComputerName`, `OSName` or `Name`. For a `member_type` other than `VirtualMachine`, only the `Tag` key is supported.
* `member_type` (Required) Specifies the type of resource to query. Must be one of: `IPSet`, `LogicalPort`, `LogicalSwitch`, `Segment`, `SegmentPort` or `VirtualMachine`.
* `operator` (Required) Specifies the query operator to use. Must be one of: `CONTAINS`, `ENDSWITH`, `EQUALS`, `NOTEQUALS` or `STARTSWITH`.
* `value` (Required) User specified string value to use in the query. For `Tag` criteria, use 'scope|value' notation if you wish to specify scope in criteria.
* `conjunction` (Required for multiple `criteria`) When specifying multiple `criteria`, a conjunction is used to specify if the criteria should selected using `AND` or `OR`.
* `operator` (Required) The operator to use. Must be one of `AND` or `OR`. If `AND` is used, then the `criteria` block before/after must be of the same type and if using `condition` then also must use the same `member_type`.
* `extended_criteria` (Optional) A condition block to specify higher level context to include in this Group's members. (e.g. user AD group). This configuration is for Local Manager only. Currently only one block is supported by NSX. Note that `extended_criteria` is implicitly `AND` with `criteria`.
* `identity_group` (Optional) A repeatable condition block selecting user AD groups to be included in this Group. Note that `identity_groups` are `OR` with each other.
* `distinguished_name` (Required for an `identity_group`) LDAP distinguished name (DN). A valid fully qualified distinguished name should be provided here. This value is valid only if it matches to exactly 1 LDAP object on the LDAP server.
* `domain_base_distinguished_name` (Required for an `identity_group`) Identity (Directory) domain base distinguished name. This is the base distinguished name for the domain where this identity group resides. (e.g. dc=example,dc=com)
* `sid` (Optional) Identity (Directory) Group SID (security identifier). A security identifier (SID) is a unique value of variable length used to identify a trustee. This field is only populated for Microsoft Active Directory identity store.
* `group_type` - (Optional) Group type can be specified during create and update of a group. Empty group type indicates a 'generic' group, ie group can be one of IPAddress, ANTREA. Attribute is supported with NSX version 3.2.0 and above.
* `distinguished_name` (Required) LDAP distinguished name (DN). A valid fully qualified distinguished name should be provided here. This value is valid only if it matches to exactly 1 LDAP object on the LDAP server.
* `domain_base_distinguished_name` (Required) Identity (Directory) domain base distinguished name. This is the base distinguished name for the domain where this identity group resides. (e.g. dc=example,dc=com)
* `sid` (Optional) Identity (Directory) Group SID (security identifier). A security identifier (SID) is a unique value of variable length used to identify a trustee. This field is only populated for Microsoft Active Directory identity store.
* `group_type` - (Optional) One of `IPAddress`, `ANTREA`. Empty group type indicates a generic group. Attribute is supported with NSX version 3.2.0 and above.


## Attributes Reference
Expand Down
12 changes: 6 additions & 6 deletions website/docs/r/policy_segment.html.markdown
View file
Original file line number Diff line number Diff line change
Expand Up @@ -72,20 +72,20 @@ The following arguments are supported:
* `dns_servers` - (Optional) List of IP addresses of DNS servers for the subnet.
* `lease_time` - (Optional) DHCP lease time in seconds.
* `dhcp_option_121` - (Optional) DHCP classless static routes.
* `network` - (Required) Destination in cidr format.
* `next_hop` - (Required) IP address of next hop.
* `network` - (Required) Destination in cidr format.
* `next_hop` - (Required) IP address of next hop.
* `dhcp_generic_option` - (Optional) Generic DHCP options.
* `code` - (Required) DHCP option code. Valid values are from 0 to 255.
* `values` - (Required) List of DHCP option values.
* `code` - (Required) DHCP option code. Valid values are from 0 to 255.
* `values` - (Required) List of DHCP option values.
* `dhcp_v6_config` - (Optional) DHCPv6 config for IPv6 subnet. This clause is supported with NSX 3.0.0 onwards.
* `server_address` - (Optional) IP address of the DHCP server in CIDR format. This attribute is required if segment has provided dhcp_config_path and it represents a DHCP server config.
* `dns_servers` - (Optional) List of IP addresses of DNS servers for the subnet.
* `lease_time` - (Optional) DHCP lease time in seconds.
* `preferred_time` - (Optional) The time interval in seconds, in which the prefix is advertised as preferred.
* `domain_names` - (Optional) List of domain names for this subnet.
* `excluded_range` - (Optional) List of excluded address ranges to define dynamic ip allocation ranges.
* `start` - (Required) IPv6 address that marks beginning of the range.
* `end` - (Required) IPv6 address that marks end of the range.
* `start` - (Required) IPv6 address that marks beginning of the range.
* `end` - (Required) IPv6 address that marks end of the range.
* `sntp_servers` - (Optional) IPv6 address of SNTP servers for the subnet.
* `l2_extension` - (Optional) Configuration for extending Segment through L2 VPN.
* `l2vpn_paths` - (Optional) Policy paths of associated L2 VPN sessions.
Expand Down
18 changes: 9 additions & 9 deletions website/docs/r/policy_tier0_gateway.html.markdown
View file
Original file line number Diff line number Diff line change
Expand Up @@ -146,17 +146,17 @@ The following arguments are supported:
* `graceful_restart_timer` - (Optional) BGP graceful restart timer. Default is `180`. This setting is not applicable to VRF-Lite Gateway.
* `graceful_restart_stale_route_timer` - (Optional) BGP stale route timer. Default is `600`. This setting is not applicable to VRF-Lite Gateway.
* `route_aggregation`- (Optional) Zero or more route aggregations for BGP.
* `prefix` - (Required) CIDR of aggregate address.
* `summary_only` - (Optional) A boolean flag to enable/disable summarized route info. Default is `true`.
* `prefix` - (Required) CIDR of aggregate address.
* `summary_only` - (Optional) A boolean flag to enable/disable summarized route info. Default is `true`.
* `vrf_config` - (Optional) VRF config for VRF Tier0. This clause is supported with NSX 3.0.0 onwards.
* `gateway_path` - (Required) Default Tier0 path. Cannot be modified after realization.
* `evpn_transit_vni` - (Optional) L3 VNI associated with the VRF for overlay traffic. VNI must be unique and belong to configured VNI pool.
* `route_distinguisher` - (Optional) Route distinguisher. Format: <ASN>:<number> or <IPAddress>:<number>.
* `route_target` - (Optional) Only one target is supported.
* `auto_mode` - (Optional) When true, import and export targets should not be specified.
* `address_family` - (Optional) Address family, currently only `L2VPN_EVPN` is supported, which is the default.
* `import_targets` - (Optional) List of import route targets. Format: <ASN>:<number>.
* `export_targets` - (Optional) List of export route targets. Format: <ASN>:<number>.
* `auto_mode` - (Optional) When true, import and export targets should not be specified.
* `address_family` - (Optional) Address family, currently only `L2VPN_EVPN` is supported, which is the default.
* `import_targets` - (Optional) List of import route targets. Format: <ASN>:<number>.
* `export_targets` - (Optional) List of export route targets. Format: <ASN>:<number>.
* `intersite_config` - (Optional) This clause is relevant for Global Manager only.
* `transit_subnet` - (Optional) IPv4 subnet for inter-site transit segment connecting service routers across sites for stretched gateway. For IPv6 link local subnet is auto configured.
* `primary_site_path` - (Optional) Primary egress site for gateway.
Expand All @@ -165,9 +165,9 @@ The following arguments are supported:
* `enabled` - Enable route redistribution for BGP. Defaults to `true`.
* `ospf_enabled` - (Optional) Enable route redistribution for OSPF. Defaults to `false`. Applicable from NSX 3.1.0 onwards.
* `rule` - (Optional) List of redistribution rules.
* `name` - (Optional) Rule name.
* `route_map_path` - (Optional) Route map to be associated with the redistribution rule.
* `types` - (Optional) List of redistribution types, possible values are: `TIER0_STATIC`, `TIER0_CONNECTED`, `TIER0_EXTERNAL_INTERFACE`, `TIER0_SEGMENT`, `TIER0_ROUTER_LINK`, `TIER0_SERVICE_INTERFACE`, `TIER0_LOOPBACK_INTERFACE`, `TIER0_DNS_FORWARDER_IP`, `TIER0_IPSEC_LOCAL_IP`, `TIER0_NAT`, `TIER0_EVPN_TEP_IP`, `TIER1_NAT`, `TIER1_STATIC`, `TIER1_LB_VIP`, `TIER1_LB_SNAT`, `TIER1_DNS_FORWARDER_IP`, `TIER1_CONNECTED`, `TIER1_SERVICE_INTERFACE`, `TIER1_SEGMENT`, `TIER1_IPSEC_LOCAL_ENDPOINT`.
* `name` - (Optional) Rule name.
* `route_map_path` - (Optional) Route map to be associated with the redistribution rule.
* `types` - (Optional) List of redistribution types, possible values are: `TIER0_STATIC`, `TIER0_CONNECTED`, `TIER0_EXTERNAL_INTERFACE`, `TIER0_SEGMENT`, `TIER0_ROUTER_LINK`, `TIER0_SERVICE_INTERFACE`, `TIER0_LOOPBACK_INTERFACE`, `TIER0_DNS_FORWARDER_IP`, `TIER0_IPSEC_LOCAL_IP`, `TIER0_NAT`, `TIER0_EVPN_TEP_IP`, `TIER1_NAT`, `TIER1_STATIC`, `TIER1_LB_VIP`, `TIER1_LB_SNAT`, `TIER1_DNS_FORWARDER_IP`, `TIER1_CONNECTED`, `TIER1_SERVICE_INTERFACE`, `TIER1_SEGMENT`, `TIER1_IPSEC_LOCAL_ENDPOINT`.

## Attributes Reference

Expand Down
12 changes: 6 additions & 6 deletions website/docs/r/policy_vlan_segment.html.markdown
View file
Original file line number Diff line number Diff line change
Expand Up @@ -75,20 +75,20 @@ The following arguments are supported:
* `dns_servers` - (Optional) List of IP addresses of DNS servers for the subnet.
* `lease_time` - (Optional) DHCP lease time in seconds.
* `dhcp_option_121` - (Optional) DHCP classless static routes.
* `network` - (Required) Destination in cidr format.
* `next_hop` - (Required) IP address of next hop.
* `network` - (Required) Destination in cidr format.
* `next_hop` - (Required) IP address of next hop.
* `dhcp_generic_option` - (Optional) Generic DHCP options.
* `code` - (Required) DHCP option code. Valid values are from 0 to 255.
* `values` - (Required) List of DHCP option values.
* `code` - (Required) DHCP option code. Valid values are from 0 to 255.
* `values` - (Required) List of DHCP option values.
* `dhcp_v6_config` - (Optional) DHCPv6 config for IPv6 subnet. This attribute is supported with NSX 3.0.0 onwards.
* `server_address` - (Optional) IP address of the DHCP server in CIDR format. This attribute is required if segment has provided dhcp_config_path and it represents a DHCP server config.
* `dns_servers` - (Optional) List of IP addresses of DNS servers for the subnet.
* `lease_time` - (Optional) DHCP lease time in seconds.
* `preferred_time` - (Optional) The time interval in seconds, in which the prefix is advertised as preferred.
* `domain_names` - (Optional) List of domain names for this subnet.
* `excluded_range` - (Optional) List of excluded address ranges to define dynamic ip allocation ranges.
* `start` - (Required) IPv6 address that marks beginning of the range.
* `end` - (Required) IPv6 address that marks end of the range.
* `start` - (Required) IPv6 address that marks beginning of the range.
* `end` - (Required) IPv6 address that marks end of the range.
* `sntp_servers` - (Optional) IPv6 address of SNTP servers for the subnet.
* `l2_extension` - (Optional) Configuration for extending Segment through L2 VPN.
* `l2vpn_paths` - (Optional) Policy paths of associated L2 VPN sessions.
Expand Down

0 comments on commit c2b2b3d

Please sign in to comment.