Skip to content

Commit

Permalink
chore: add vdi related attributes to network_security rule wensite doc
Browse files Browse the repository at this point in the history
  • Loading branch information
@marinsalinas
marinsalinas committed Jan 11, 2021
1 parent cf49b03 commit 60a86cc
Show file tree
Hide file tree
Showing 2 changed files with 59 additions and 43 deletions.
78 changes: 43 additions & 35 deletions website/docs/d/network_security_rule.html.markdown
View file
Original file line number Diff line number Diff line change
Expand Up @@ -52,48 +52,56 @@ The following arguments are supported:
The following attributes are exported:

The following arguments are supported:

* `name`: - (Required) The name for the image.
* `categories`: - (Optional) Categories for the image.
* `project_reference`: - (Optional) The reference to a project.
* `owner_reference`: - (Optional) The reference to a user.
* `api_version` - (Optional)
* `description`: - (Optional) A description for image.
* `quarantine_rule_action`: - (Optional) These rules are used for quarantining suspected VMs. Target group is a required attribute. Empty inbound_allow_list will not allow anything into target group. Empty outbound_allow_list will allow everything from target group.
* `quarantine_rule_outbound_allow_list`: - (Optional)
* `quarantine_rule_target_group_default_internal_policy`: - (Optional) - Default policy for communication within target group.
* `quarantine_rule_target_group_peer_specification_type`: - (Optional) - Way to identify the object for which rule is applied.
* `quarantine_rule_target_group_filter_kind_list`: - (Optional) - List of kinds associated with this filter.
* `quarantine_rule_target_group_filter_type`: - (Optional) - The type of the filter being used.
* `quarantine_rule_target_group_filter_params`: - (Optional) - A list of category key and list of values.
* `quarantine_rule_inbound_allow_list`: - (Optional)
* `app_rule_action`: - (Optional) - These rules govern what flows are allowed. Target group is a required attribute. Empty inbound_allow_list will not anything into target group. Empty outbound_allow_list will allow everything from target group.
* `app_rule_outbound_allow_list`: - (Optional)
* `app_rule_target_group_default_internal_policy`: - (Optional) - Default policy for communication within target group.
* `app_rule_target_group_peer_specification_type`: - (Optional) - Way to identify the object for which rule is applied.
* `app_rule_target_group_filter_kind_list`: - (Optional) - List of kinds associated with this filter.
* `app_rule_target_group_filter_type`: - (Optional) - The type of the filter being used.
* `app_rule_target_group_filter_params`: - (Optional) - A list of category key and list of values.
* `app_rule_inbound_allow_list`: - (Optional)
* `isolation_rule_action`: - (Optional) - These rules are used for environmental isolation.
* `app_rule_inbound_allow_list`: - (Optional)
* `isolation_rule_first_entity_filter_kind_list`: - (Optional) - List of kinds associated with this filter.
* `isolation_rule_first_entity_filter_type`: - (Optional) - The type of the filter being used.
* `isolation_rule_first_entity_filter_params`: - (Optional) - A list of category key and list of values.
* `isolation_rule_second_entity_filter_kind_list`: - (Optional) - List of kinds associated with this filter.
* `isolation_rule_second_entity_filter_type`: - (Optional) - The type of the filter being used.
* `isolation_rule_second_entity_filter_params`: - (Optional) - A list of category key and list of values.
* `network_security_rule_id` - (Required) The ID for the rule you want to retrieve.
* `name`: - The name for the network_security_rule.
* `categories`: Categories for the network_security_rule.
* `project_reference`: The reference to a project.
* `owner_reference`: The reference to a user.
* `api_version`
* `description`: A description for network_security_rule.
* `quarantine_rule_action`: These rules are used for quarantining suspected VMs. Target group is a required attribute. Empty inbound_allow_list will not allow anything into target group. Empty outbound_allow_list will allow everything from target group.
* `quarantine_rule_outbound_allow_list`:
* `quarantine_rule_target_group_default_internal_policy`: - Default policy for communication within target group.
* `quarantine_rule_target_group_peer_specification_type`: - Way to identify the object for which rule is applied.
* `quarantine_rule_target_group_filter_kind_list`: - List of kinds associated with this filter.
* `quarantine_rule_target_group_filter_type`: - The type of the filter being used.
* `quarantine_rule_target_group_filter_params`: - A list of category key and list of values.
* `quarantine_rule_inbound_allow_list`:
* `app_rule_action`: - These rules govern what flows are allowed. Target group is a required attribute. Empty inbound_allow_list will not anything into target group. Empty outbound_allow_list will allow everything from target group.
* `app_rule_outbound_allow_list`:
* `app_rule_target_group_default_internal_policy`: - Default policy for communication within target group.
* `app_rule_target_group_peer_specification_type`: - Way to identify the object for which rule is applied.
* `app_rule_target_group_filter_kind_list`: - List of kinds associated with this filter.
* `app_rule_target_group_filter_type`: - The type of the filter being used.
* `app_rule_target_group_filter_params`: - A list of category key and list of values.
* `app_rule_inbound_allow_list`: The set of categories that matching VMs need to have.
* `ad_rule_action`: - These rules govern what flows are allowed. Target group is a required attribute. Empty inbound_allow_list will not anything into target group. Empty outbound_allow_list will allow everything from target group.
* `ad_rule_outbound_allow_list`:
* `ad_rule_target_group_default_internal_policy`: - Default policy for communication within target group.
* `ad_rule_target_group_peer_specification_type`: - Way to identify the object for which rule is applied.
* `ad_rule_target_group_filter_kind_list`: - List of kinds associated with this filter.
* `ad_rule_target_group_filter_type`: - The type of the filter being used.
* `ad_rule_target_group_filter_params`: - A list of category key and list of values.
* `ad_rule_inbound_allow_list`: The set of categories that matching VMs need to have.
* `isolation_rule_action`: - These rules are used for environmental isolation.
* `app_rule_inbound_allow_list`:
* `isolation_rule_first_entity_filter_kind_list`: - List of kinds associated with this filter.
* `isolation_rule_first_entity_filter_type`: - The type of the filter being used.
* `isolation_rule_first_entity_filter_params`: - A list of category key and list of values.
* `isolation_rule_second_entity_filter_kind_list`: - List of kinds associated with this filter.
* `isolation_rule_second_entity_filter_type`: - The type of the filter being used.
* `isolation_rule_second_entity_filter_params`: - A list of category key and list of values.

### Metadata

The metadata attribute exports the following:

* `last_update_time`: - UTC date and time in RFC-3339 format when image was last updated.
* `UUID`: - image UUID.
* `creation_time`: - UTC date and time in RFC-3339 format when image was created.
* `last_update_time`: - UTC date and time in RFC-3339 format when network_security_rule was last updated.
* `UUID`: - network_security_rule UUID.
* `creation_time`: - UTC date and time in RFC-3339 format when network_security_rule was created.
* `spec_version`: - Version number of the latest spec.
* `spec_hash`: - Hash of the spec. This will be returned from server.
* `name`: - image name.
* `name`: - network_security_rule name.
* `should_force_translate`: - Applied on Prism Central only. Indicate whether force to translate the spec of the fanout request to fit the target cluster API schema.

### Categories
Expand Down
24 changes: 16 additions & 8 deletions website/docs/r/network_security_rule.html.markdown
View file
Original file line number Diff line number Diff line change
Expand Up @@ -268,11 +268,11 @@ resource "nutanix_network_security_rule" "TEST-TIER" {

The following arguments are supported:

* `name`: - (Required) The name for the image.
* `categories`: - (Optional) Categories for the image.
* `name`: - (Required) The name for the network_security_rule.
* `categories`: - (Optional) Categories for the network_security_rule.
* `project_reference`: - (Optional) The reference to a project.
* `owner_reference`: - (Optional) The reference to a user.
* `description`: - (Optional) A description for image.
* `description`: - (Optional) A description for network_security_rule.
* `quarantine_rule_action`: - (Optional) These rules are used for quarantining suspected VMs. Target group is a required attribute. Empty inbound_allow_list will not allow anything into target group. Empty outbound_allow_list will allow everything from target group.
* `quarantine_rule_outbound_allow_list`: - (Optional)
* `quarantine_rule_target_group_default_internal_policy`: - (Optional) - Default policy for communication within target group.
Expand All @@ -288,7 +288,15 @@ The following arguments are supported:
* `app_rule_target_group_filter_kind_list`: - (Optional) - List of kinds associated with this filter.
* `app_rule_target_group_filter_type`: - (Optional) - The type of the filter being used.
* `app_rule_target_group_filter_params`: - (Optional) - A list of category key and list of values.
* `app_rule_inbound_allow_list`: - (Optional)
* `app_rule_inbound_allow_list`: - (Optional) The set of categories that matching VMs need to have.
* `ad_rule_action`: - (Optional) - These rules govern what flows are allowed. Target group is a required attribute. Empty inbound_allow_list will not anything into target group. Empty outbound_allow_list will allow everything from target group.
* `ad_rule_outbound_allow_list`: - (Optional)
* `ad_rule_target_group_default_internal_policy`: - (Optional) - Default policy for communication within target group.
* `ad_rule_target_group_peer_specification_type`: - (Optional) - Way to identify the object for which rule is applied.
* `ad_rule_target_group_filter_kind_list`: - (Optional) - List of kinds associated with this filter.
* `ad_rule_target_group_filter_type`: - (Optional) - The type of the filter being used.
* `ad_rule_target_group_filter_params`: - (Optional) - A list of category key and list of values.
* `ad_rule_inbound_allow_list`: - (Optional) The set of categories that matching VMs need to have.
* `isolation_rule_action`: - (Optional) - These rules are used for environmental isolation.
* `app_rule_inbound_allow_list`: - (Optional)
* `isolation_rule_first_entity_filter_kind_list`: - (Optional) - List of kinds associated with this filter.
Expand All @@ -302,9 +310,9 @@ The following arguments are supported:

The following attributes are exported:

* `metadata`: - The image kind metadata.
* `retrieval_uri_list`: - List of URIs where the raw image data can be accessed.
* `size_bytes`: - The size of the image in bytes.
* `metadata`: - The network_security_rule kind metadata.
* `retrieval_uri_list`: - List of URIs where the raw network_security_rule data can be accessed.
* `size_bytes`: - The size of the network_security_rule in bytes.
* `state`: - The state of the Network Security Rule.
* `api_version` - The version of the API.

Expand All @@ -328,4 +336,4 @@ The `project_reference`, `owner_reference`, `availability_zone_reference`, `clus
* `name`: - the name(Optional).
* `uuid`: - the UUID(Required).

See detailed information in [Nutanix Image](https://nutanix.github.io/Automation/experimental/swagger-redoc-sandbox/#tag/network_security_rules/paths/~1network_security_rules~1{UUID}/put).
See detailed information in [Nutanix Network Security Rule](https://www.nutanix.dev/reference/prism_central/v3/api/network-security-rules/postnetworksecurityrules/).

0 comments on commit 60a86cc

Please sign in to comment.