Skip to content

Commit

Permalink
Tag arguments as required or optional
Browse files Browse the repository at this point in the history
Some arguments within documentation were missing these.

Signed-off-by: Kobi Samoray <[email protected]>
  • Loading branch information
ksamoray committed Aug 1, 2023
1 parent ca20b09 commit 5cf7143
Show file tree
Hide file tree
Showing 54 changed files with 55 additions and 55 deletions.
2 changes: 1 addition & 1 deletion website/docs/d/policy_context_profile.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ data "nsxt_policy_context_profile" "demoprof" {
* `id` - (Optional) The ID of Profile to retrieve.
* `display_name` - (Optional) The Display Name prefix of the Profile to retrieve.
* `context` - (Optional) The context which the object belongs to
* `project_id` - The ID of the project which the object belongs to
* `project_id` - (Required) The ID of the project which the object belongs to

## Attributes Reference

Expand Down
2 changes: 1 addition & 1 deletion website/docs/d/policy_dhcp_server.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ data "nsxt_policy_dhcp_server" "demodhcp" {
* `id` - (Optional) The ID of DHCP Server to retrieve. If ID is specified, no additional argument should be configured.
* `display_name` - (Optional) The Display Name prefix of DHCP server to retrieve.
* `context` - (Optional) The context which the object belongs to
* `project_id` - The ID of the project which the object belongs to
* `project_id` - (Required) The ID of the project which the object belongs to

## Attributes Reference

Expand Down
2 changes: 1 addition & 1 deletion website/docs/d/policy_gateway_locale_service.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ data "nsxt_policy_gateway_locale_service" "demoserv" {
* `id` - (Optional) The ID of locale service gateway to retrieve.
* `display_name` - (Optional) The Display Name or prefix of locale service to retrieve.
* `context` - (Optional) The context which the object belongs to
* `project_id` - The ID of the project which the object belongs to
* `project_id` - (Required) The ID of the project which the object belongs to

## Attributes Reference

Expand Down
2 changes: 1 addition & 1 deletion website/docs/d/policy_gateway_policy.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ data "nsxt_policy_gateway_policy" "demopolicy" {
* `category` - (Optional) Category of the policy to retrieve. May be useful to retrieve default policy.
* `display_name` - (Optional) The Display Name prefix of the policy to retrieve.
* `context` - (Optional) The context which the object belongs to
* `project_id` - The ID of the project which the object belongs to
* `project_id` - (Required) The ID of the project which the object belongs to

## Attributes Reference

Expand Down
2 changes: 1 addition & 1 deletion website/docs/d/policy_gateway_qos_profile.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ data "nsxt_policy_gateway_qos_profile" "qosprof" {
* `id` - (Optional) The ID of GatewayQosProfile to retrieve.
* `display_name` - (Optional) The Display Name prefix of the Gateway QoS Profile to retrieve.
* `context` - (Optional) The context which the object belongs to
* `project_id` - The ID of the project which the object belongs to
* `project_id` - (Required) The ID of the project which the object belongs to

## Attributes Reference

Expand Down
2 changes: 1 addition & 1 deletion website/docs/d/policy_group.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ data "nsxt_policy_group" "demogroup" {
* `display_name` - (Optional) The Display Name prefix of the Group to retrieve.
* `domain` - (Optional) The domain this Group belongs to. For VMware Cloud on AWS use `cgw`. For Global Manager, please use site id for this field. If not specified, this field is default to `default`.
* `context` - (Optional) The context which the object belongs to
* `project_id` - The ID of the project which the object belongs to
* `project_id` - (Required) The ID of the project which the object belongs to

## Attributes Reference

Expand Down
2 changes: 1 addition & 1 deletion website/docs/d/policy_ip_block.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ data "nsxt_policy_ip_block" "demoblock" {
* `id` - (Optional) The ID of IP Block to retrieve.
* `display_name` - (Optional) The Display Name prefix of the IP Block to retrieve.
* `context` - (Optional) The context which the object belongs to
* `project_id` - The ID of the project which the object belongs to
* `project_id` - (Required) The ID of the project which the object belongs to

## Attributes Reference

Expand Down
2 changes: 1 addition & 1 deletion website/docs/d/policy_ip_discovery_profile.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ data "nsxt_policy_ip_discovery_profile" "demoprof" {
* `id` - (Optional) The ID of Profile to retrieve.
* `display_name` - (Optional) The Display Name prefix of the Profile to retrieve.
* `context` - (Optional) The context which the object belongs to
* `project_id` - The ID of the project which the object belongs to
* `project_id` - (Required) The ID of the project which the object belongs to

## Attributes Reference

Expand Down
2 changes: 1 addition & 1 deletion website/docs/d/policy_ip_pool.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ data "nsxt_policy_ip_pool" "demopool" {
* `id` - (Optional) The ID of IP Pool Config to retrieve.
* `display_name` - (Optional) The Display Name prefix of the IP Pool Config to retrieve.
* `context` - (Optional) The context which the object belongs to
* `project_id` - The ID of the project which the object belongs to
* `project_id` - (Required) The ID of the project which the object belongs to

## Attributes Reference

Expand Down
2 changes: 1 addition & 1 deletion website/docs/d/policy_ipv6_dad_profile.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ data "nsxt_policy_ipv6_dad_profile" "demodad6" {
* `id` - (Optional) The ID of Profile to retrieve.
* `display_name` - (Optional) The Display Name prefix of the Profile to retrieve.
* `context` - (Optional) The context which the object belongs to
* `project_id` - The ID of the project which the object belongs to
* `project_id` - (Required) The ID of the project which the object belongs to

## Attributes Reference

Expand Down
2 changes: 1 addition & 1 deletion website/docs/d/policy_ipv6_ndra_profile.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ data "nsxt_policy_ipv6_ndra_profile" "demondra" {
* `id` - (Optional) The ID of Profile to retrieve.
* `display_name` - (Optional) The Display Name prefix of the Profile to retrieve.
* `context` - (Optional) The context which the object belongs to
* `project_id` - The ID of the project which the object belongs to
* `project_id` - (Required) The ID of the project which the object belongs to

## Attributes Reference

Expand Down
2 changes: 1 addition & 1 deletion website/docs/d/policy_mac_discovery_profile.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ data "nsxt_policy_mac_discovery_profile" "macprof" {
* `id` - (Optional) The ID of Profile to retrieve.
* `display_name` - (Optional) The Display Name prefix of Profile to retrieve.
* `context` - (Optional) The context which the object belongs to
* `project_id` - The ID of the project which the object belongs to
* `project_id` - (Required) The ID of the project which the object belongs to

## Attributes Reference

Expand Down
2 changes: 1 addition & 1 deletion website/docs/d/policy_qos_profile.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ data "nsxt_policy_qos_profile" "demoqosprof" {
* `id` - (Optional) The ID of Profile to retrieve.
* `display_name` - (Optional) The Display Name prefix of the Profile to retrieve.
* `context` - (Optional) The context which the object belongs to
* `project_id` - The ID of the project which the object belongs to
* `project_id` - (Required) The ID of the project which the object belongs to

## Attributes Reference

Expand Down
2 changes: 1 addition & 1 deletion website/docs/d/policy_realization_info.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ data "nsxt_policy_realization_info" "info" {
* `delay` - (Optional) Delay (in seconds) before realization polling is started. Default is set to 1.
* `timeout` - (Optional) Timeout (in seconds) for realization polling. Default is set to 1200.
* `context` - (Optional) The context which the object belongs to
* `project_id` - The ID of the project which the object belongs to
* `project_id` - (Required) The ID of the project which the object belongs to

## Attributes Reference

Expand Down
2 changes: 1 addition & 1 deletion website/docs/d/policy_security_policy.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ data "nsxt_policy_security_policy" "predefined" {
* `category` - (Optional) Category of the policy to retrieve.
* `display_name` - (Optional) The Display Name of the policy to retrieve.
* `context` - (Optional) The context which the object belongs to
* `project_id` - The ID of the project which the object belongs to
* `project_id` - (Required) The ID of the project which the object belongs to

## Attributes Reference

Expand Down
2 changes: 1 addition & 1 deletion website/docs/d/policy_segment.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ data "nsxt_policy_segment" "demoseg" {
* `id` - (Optional) The ID of Segment to retrieve. If ID is specified, no additional argument should be configured.
* `display_name` - (Optional) The Display Name prefix of the Segment to retrieve.
* `context` - (Optional) The context which the object belongs to
* `project_id` - The ID of the project which the object belongs to
* `project_id` - (Required) The ID of the project which the object belongs to

## Attributes Reference

Expand Down
2 changes: 1 addition & 1 deletion website/docs/d/policy_segment_realization.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ data "vsphere_network" "net" {

* `path` - (Required) The policy path of the segment.
* `context` - (Optional) The context which the object belongs to
* `project_id` - The ID of the project which the object belongs to
* `project_id` - (Required) The ID of the project which the object belongs to

## Attributes Reference

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ data "nsxt_policy_segment_security_profile" "demosegprof" {
* `id` - (Optional) The ID of SegmentSecurityProfile to retrieve.
* `display_name` - (Optional) The Display Name prefix of the SegmentSecurityProfile to retrieve.
* `context` - (Optional) The context which the object belongs to
* `project_id` - The ID of the project which the object belongs to
* `project_id` - (Required) The ID of the project which the object belongs to

## Attributes Reference

Expand Down
2 changes: 1 addition & 1 deletion website/docs/d/policy_service.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ data "nsxt_policy_service" "demodnssvc" {
* `id` - (Optional) The ID of service to retrieve.
* `display_name` - (Optional) The Display Name prefix of the service to retrieve.
* `context` - (Optional) The context which the object belongs to
* `project_id` - The ID of the project which the object belongs to
* `project_id` - (Required) The ID of the project which the object belongs to

## Attributes Reference

Expand Down
2 changes: 1 addition & 1 deletion website/docs/d/policy_spoofguard_profile.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ data "nsxt_policy_spoofguard_profile" "demosgprof" {
* `id` - (Optional) The ID of SpoofGuardProfile to retrieve.
* `display_name` - (Optional) The Display Name prefix of the SpoofGuardProfile to retrieve.
* `context` - (Optional) The context which the object belongs to
* `project_id` - The ID of the project which the object belongs to
* `project_id` - (Required) The ID of the project which the object belongs to

## Attributes Reference

Expand Down
2 changes: 1 addition & 1 deletion website/docs/d/policy_tier1_gateway.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ data "nsxt_policy_tier1_gateway" "demotier1" {
* `id` - (Optional) The ID of Tier-1 gateway to retrieve.
* `display_name` - (Optional) The Display Name prefix of the Tier-1 gateway to retrieve.
* `context` - (Optional) The context which the object belongs to
* `project_id` - The ID of the project which the object belongs to
* `project_id` - (Required) The ID of the project which the object belongs to

## Attributes Reference

Expand Down
2 changes: 1 addition & 1 deletion website/docs/r/nat_rule.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ The following arguments are supported:
* `nat_pass` - (Optional) Enable/disable to bypass following firewall stage. The default is true, meaning that the following firewall stage will be skipped. Please note, if action is NO_NAT, then nat_pass must be set to true or omitted.
* `translated_network` - (Required for action=DNAT or SNAT) IP Address | IP Range | CIDR.
* `translated_ports` - (Optional) port number or port range. Allowed only when action=DNAT.
* `rule_priority` - The priority of the rule which is ascending, valid range [0-2147483647]. If multiple rules have the same priority, evaluation sequence is undefined.
* `rule_priority` - (Optional) The priority of the rule which is ascending, valid range [0-2147483647]. If multiple rules have the same priority, evaluation sequence is undefined.


## Attributes Reference
Expand Down
4 changes: 2 additions & 2 deletions website/docs/r/policy_context_profile.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ Note: At least one of `app_id`, `custom_url`, domain_name`, or `url_category` mu
* `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.
* `context` - (Optional) The context which the object belongs to
* `project_id` - The ID of the project which the object belongs to
* `project_id` - (Required) The ID of the project which the object belongs to
* `app_id` - (Optional) A block to specify app id attributes for the context profile. Only one block is allowed.
* `description` - (Optional) Description of the attribute.
* `value` - (Required) A list of string indicating values for the `app_id`. Must be a subset of valid values for `app_id` on NSX.
Expand All @@ -95,7 +95,7 @@ Note: At least one of `app_id`, `custom_url`, domain_name`, or `url_category` mu
* `tls_version` - (Optional) A list of string indicating values for `tls_version`, only applicable to `SSL`.
* `cifs_smb_version` - (Optional) A list of string indicating values for `cifs_smb_version`, only applicable to `CIFS`.
* `custom_url` - (Optional) A block to specify custom URL attributes for the context profile. Only one block is allowed.
* `custom_url_partial_match` - True value for this flag will be treated as a partial match for custom url. Attribute is supported with NSX version 4.0.0 and above.
* `custom_url_partial_match` - (Optional) True value for this flag will be treated as a partial match for custom url. Attribute is supported with NSX version 4.0.0 and above.
* `description` - (Optional) Description of the attribute.
* `value` - (Required) A list of string indicating values for the `custom_url`. Must be a subset of valid values for `custom_url` on NSX.
* `domain_name` - (Optional) A block to specify domain name (FQDN) attributes for the context profile. Only one block is allowed.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ Note: `key`, `attribute` must be present.
* `key` - (Required) Policy Custom Attribute Key. Valid values are "DOMAIN_NAME" and "CUSTOM_URL"
* `attribute` - (Required) FQDN or URL to be used as custom attribute.
* `context` - (Optional) The context which the object belongs to
* `project_id` - The ID of the project which the object belongs to
* `project_id` - (Required) The ID of the project which the object belongs to

## Importing

Expand Down
2 changes: 1 addition & 1 deletion website/docs/r/policy_dhcp_relay.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ The following arguments are supported:
* `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.
* `context` - (Optional) The context which the object belongs to
* `project_id` - The ID of the project which the object belongs to
* `project_id` - (Required) The ID of the project which the object belongs to
* `server_addresses` - (Required) List of DHCP server addresses.


Expand Down
2 changes: 1 addition & 1 deletion website/docs/r/policy_dhcp_server.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ The following arguments are supported:
* `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.
* `context` - (Optional) The context which the object belongs to
* `project_id` - The ID of the project which the object belongs to
* `project_id` - (Required) The ID of the project which the object belongs to
* `edge_cluster_path` - (Optional) The Policy path to the edge cluster for this DHCP Server.
* `lease_time` - (Optional) IP address lease time in seconds. Valid values from `60` to `4294967295`. Default is `86400`.
* `preferred_edge_paths` - (Optional) Policy paths to edge nodes. The first edge node is assigned as active edge, and second one as standby edge.
Expand Down
2 changes: 1 addition & 1 deletion website/docs/r/policy_dhcp_v4_static_binding.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ The following arguments are supported:
* `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.
* `context` - (Optional) The context which the object belongs to
* `project_id` - The ID of the project which the object belongs to
* `project_id` - (Required) The ID of the project which the object belongs to
* `ip_address` - (Required) The IPv4 address must belong to the subnet, if any, configured on Segment.
* `mac_address` - (Required) MAC address of the host.
* `gateway_address` - (Optional) Gateway IPv4 Address. When not specified, gateway address is auto-assigned from segment configuration.
Expand Down
2 changes: 1 addition & 1 deletion website/docs/r/policy_dhcp_v6_static_binding.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ The following arguments are supported:
* `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.
* `context` - (Optional) The context which the object belongs to
* `project_id` - The ID of the project which the object belongs to
* `project_id` - (Required) The ID of the project which the object belongs to
* `ip_addresses` - (Optional) List of IPv6 addresses.
* `mac_address` - (Required) MAC address of the host.
* `lease_time` - (Optional) Lease time, in seconds. Defaults to 86400.
Expand Down
2 changes: 1 addition & 1 deletion website/docs/r/policy_dns_forwarder_zone.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ The following arguments are supported:
* `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.
* `context` - (Optional) The context which the object belongs to
* `project_id` - The ID of the project which the object belongs to
* `project_id` - (Required) The ID of the project which the object belongs to
* `upstream_servers` - (Required) List of server IP addresses for this Forwarder Zone.
* `dns_domain_names` - (Optional) For conditional (FQDN) zones, a list of maximum 5 domains. For Default Forwarder Zone, this attribute should not be specified.
* `source_ip` - (Optional) The source IP address used by the DNS Forwarder zone.
Expand Down
2 changes: 1 addition & 1 deletion website/docs/r/policy_fixed_segment.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ The following arguments are supported:
* `nsx_id` - (Optional) The NSX ID of this resource. If set, this ID will be used to create the resource.
* `connectivity_path` - (Required) Policy path to the connecting Tier-0 or Tier-1.
* `context` - (Optional) The context which the object belongs to
* `project_id` - The ID of the project which the object belongs to
* `project_id` - (Required) The ID of the project which the object belongs to
* `domain_name`- (Optional) DNS domain names.
* `overlay_id` - (Optional) Overlay connectivity ID for this Segment.
* `vlan_ids` - (Optional) List of VLAN IDs or ranges. Specifying vlan ids can be useful for overlay segments, f.e. for EVPN.
Expand Down
2 changes: 1 addition & 1 deletion website/docs/r/policy_gateway_dns_forwarder.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ The following arguments are supported:
* `description` - (Optional) Description of the resource.
* `tag` - (Optional) A list of scope + tag pairs to associate with this resource.
* `context` - (Optional) The context which the object belongs to
* `project_id` - The ID of the project which the object belongs to
* `project_id` - (Required) The ID of the project which the object belongs to
* `default_forwarder_zone_path` - (Required) Path of Default Forwarder Zone.
* `conditional_forwarder_zone_paths` - (Optional) List of conditional (FQDN) Zone Paths (Maximum 5 zones).
* `enabled` - (Optional) Flag to indicate whether this DNS Forwarder is enabled. Defaults to `true`.
Expand Down
2 changes: 1 addition & 1 deletion website/docs/r/policy_gateway_policy.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -133,7 +133,7 @@ The following arguments are supported:
* `tag` - (Optional) A list of scope + tag pairs to associate with this Gateway Policy.
* `nsx_id` - (Optional) The NSX ID of this resource. If set, this ID will be used to create the Gateway Policy resource.
* `context` - (Optional) The context which the object belongs to
* `project_id` - The ID of the project which the object belongs to
* `project_id` - (Required) The ID of the project which the object belongs to
* `comments` - (Optional) Comments for this Gateway Policy including lock/unlock comments.
* `locked` - (Optional) A boolean value indicating if the policy is locked. If locked, no other users can update the resource.
* `sequence_number` - (Optional) An int value used to resolve conflicts between security policies across domains
Expand Down
2 changes: 1 addition & 1 deletion website/docs/r/policy_group.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -195,7 +195,7 @@ The following arguments are supported:
* `tag` - (Optional) A list of scope + tag pairs to associate with this Group.
* `nsx_id` - (Optional) The NSX ID of this resource. If set, this ID will be used to create the group resource.
* `context` - (Optional) The context which the object belongs to
* `project_id` - The ID of the project which the object belongs to
* `project_id` - (Required) The ID of the project which the object belongs to
* `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.
Expand Down
Loading

0 comments on commit 5cf7143

Please sign in to comment.