ICMPV4 feature

CiscoDevNet · Jan 14, 2025 · 810ae7d · 810ae7d
1 parent b415086
commit 810ae7d
Show file tree

Hide file tree

Showing 62 changed files with 2,868 additions and 0 deletions.
diff --git a/docs/data-sources/icmpv4.md b/docs/data-sources/icmpv4.md
@@ -0,0 +1,33 @@
+---
+# generated by https://github.com/hashicorp/terraform-plugin-docs
+page_title: "nxos_icmpv4 Data Source - terraform-provider-nxos"
+subcategory: "ICMP"
+description: |-
+  This data source can read the global ICMP configuration.
+  API Documentation: icmpv4Entity https://pubhub.devnetcloud.com/media/dme-docs-10-2-2/docs/Routing%20and%20Forwarding/icmpv4:Entity/
+---
+
+# nxos_icmpv4 (Data Source)
+
+This data source can read the global ICMP configuration.
+
+- API Documentation: [icmpv4Entity](https://pubhub.devnetcloud.com/media/dme-docs-10-2-2/docs/Routing%20and%20Forwarding/icmpv4:Entity/)
+
+## Example Usage
+
+```terraform
+data "nxos_icmpv4" "example" {
+}
+```
+
+<!-- schema generated by tfplugindocs -->
+## Schema
+
+### Optional
+
+- `device` (String) A device name from the provider configuration.
+
+### Read-Only
+
+- `admin_state` (String) Administrative state.
+- `id` (String) The distinguished name of the object.
diff --git a/docs/data-sources/icmpv4_instance.md b/docs/data-sources/icmpv4_instance.md
@@ -0,0 +1,33 @@
+---
+# generated by https://github.com/hashicorp/terraform-plugin-docs
+page_title: "nxos_icmpv4_instance Data Source - terraform-provider-nxos"
+subcategory: "ICMP"
+description: |-
+  This data source can read the global ICMP Instance configuration.
+  API Documentation: icmpv4Inst https://pubhub.devnetcloud.com/media/dme-docs-10-2-2/docs/Routing%20and%20Forwarding/icmpv4:Instance/
+---
+
+# nxos_icmpv4_instance (Data Source)
+
+This data source can read the global ICMP Instance configuration.
+
+- API Documentation: [icmpv4Inst](https://pubhub.devnetcloud.com/media/dme-docs-10-2-2/docs/Routing%20and%20Forwarding/icmpv4:Instance/)
+
+## Example Usage
+
+```terraform
+data "nxos_icmpv4_instance" "example" {
+}
+```
+
+<!-- schema generated by tfplugindocs -->
+## Schema
+
+### Optional
+
+- `device` (String) A device name from the provider configuration.
+
+### Read-Only
+
+- `admin_state` (String) Administrative state.
+- `id` (String) The distinguished name of the object.
diff --git a/docs/data-sources/icmpv4_interface.md b/docs/data-sources/icmpv4_interface.md
@@ -0,0 +1,40 @@
+---
+# generated by https://github.com/hashicorp/terraform-plugin-docs
+page_title: "nxos_icmpv4_interface Data Source - terraform-provider-nxos"
+subcategory: "ICMP"
+description: |-
+  This data source can read the global ICMP Instance configuration.
+  API Documentation: icmpv4If https://pubhub.devnetcloud.com/media/dme-docs-10-2-2/docs/Routing%20and%20Forwarding/icmpv4:If/
+---
+
+# nxos_icmpv4_interface (Data Source)
+
+This data source can read the global ICMP Instance configuration.
+
+- API Documentation: [icmpv4If](https://pubhub.devnetcloud.com/media/dme-docs-10-2-2/docs/Routing%20and%20Forwarding/icmpv4:If/)
+
+## Example Usage
+
+```terraform
+data "nxos_icmpv4_interface" "example" {
+  vrf_name     = "VRF1"
+  interface_id = "vlan10"
+}
+```
+
+<!-- schema generated by tfplugindocs -->
+## Schema
+
+### Required
+
+- `interface_id` (String) Must match first field in the output of `show intf brief`. Example: `vlan100`.
+- `vrf_name` (String) VRF name.
+
+### Optional
+
+- `device` (String) A device name from the provider configuration.
+
+### Read-Only
+
+- `control` (String) ICMP interface control.
+- `id` (String) The distinguished name of the object.
diff --git a/docs/data-sources/icmpv4_vrf.md b/docs/data-sources/icmpv4_vrf.md
@@ -0,0 +1,37 @@
+---
+# generated by https://github.com/hashicorp/terraform-plugin-docs
+page_title: "nxos_icmpv4_vrf Data Source - terraform-provider-nxos"
+subcategory: "ICMP"
+description: |-
+  This data source can read the global ICMP Domain configuration.
+  API Documentation: icmpv4Dom https://pubhub.devnetcloud.com/media/dme-docs-10-2-2/docs/Routing%20and%20Forwarding/icmpv4:Dom/
+---
+
+# nxos_icmpv4_vrf (Data Source)
+
+This data source can read the global ICMP Domain configuration.
+
+- API Documentation: [icmpv4Dom](https://pubhub.devnetcloud.com/media/dme-docs-10-2-2/docs/Routing%20and%20Forwarding/icmpv4:Dom/)
+
+## Example Usage
+
+```terraform
+data "nxos_icmpv4_vrf" "example" {
+  vrf_name = "VRF1"
+}
+```
+
+<!-- schema generated by tfplugindocs -->
+## Schema
+
+### Required
+
+- `vrf_name` (String) VRF name
+
+### Optional
+
+- `device` (String) A device name from the provider configuration.
+
+### Read-Only
+
+- `id` (String) The distinguished name of the object.
diff --git a/docs/guides/supported_objects.md b/docs/guides/supported_objects.md
@@ -72,6 +72,10 @@ For the following DME objects a corresponding Terraform resource and data source
 | [hmmEntity](https://pubhub.devnetcloud.com/media/dme-docs-10-2-2/docs/Host%20Mobility/hmm:Entity/) | [nxos_hmm](https://registry.terraform.io/providers/CiscoDevNet/nxos/latest/docs/resources/hmm) | [nxos_hmm](https://registry.terraform.io/providers/CiscoDevNet/nxos/latest/docs/data-sources/hmm) |
 | [hmmFwdInst](https://pubhub.devnetcloud.com/media/dme-docs-10-2-2/docs/Host%20Mobility/hmm:FwdInst/) | [nxos_hmm_instance](https://registry.terraform.io/providers/CiscoDevNet/nxos/latest/docs/resources/hmm_instance) | [nxos_hmm_instance](https://registry.terraform.io/providers/CiscoDevNet/nxos/latest/docs/data-sources/hmm_instance) |
 | [hmmFwdIf](https://pubhub.devnetcloud.com/media/dme-docs-10-2-2/docs/Host%20Mobility/hmm:FwdIf/) | [nxos_hmm_interface](https://registry.terraform.io/providers/CiscoDevNet/nxos/latest/docs/resources/hmm_interface) | [nxos_hmm_interface](https://registry.terraform.io/providers/CiscoDevNet/nxos/latest/docs/data-sources/hmm_interface) |
+| [icmpv4Entity](https://pubhub.devnetcloud.com/media/dme-docs-10-2-2/docs/Routing%20and%20Forwarding/icmpv4:Entity/) | [nxos_icmpv4](https://registry.terraform.io/providers/CiscoDevNet/nxos/latest/docs/resources/icmpv4) | [nxos_icmpv4](https://registry.terraform.io/providers/CiscoDevNet/nxos/latest/docs/data-sources/icmpv4) |
+| [icmpv4Inst](https://pubhub.devnetcloud.com/media/dme-docs-10-2-2/docs/Routing%20and%20Forwarding/icmpv4:Instance/) | [nxos_icmpv4_instance](https://registry.terraform.io/providers/CiscoDevNet/nxos/latest/docs/resources/icmpv4_instance) | [nxos_icmpv4_instance](https://registry.terraform.io/providers/CiscoDevNet/nxos/latest/docs/data-sources/icmpv4_instance) |
+| [icmpv4If](https://pubhub.devnetcloud.com/media/dme-docs-10-2-2/docs/Routing%20and%20Forwarding/icmpv4:If/) | [nxos_icmpv4_interface](https://registry.terraform.io/providers/CiscoDevNet/nxos/latest/docs/resources/icmpv4_interface) | [nxos_icmpv4_interface](https://registry.terraform.io/providers/CiscoDevNet/nxos/latest/docs/data-sources/icmpv4_interface) |
+| [icmpv4Dom](https://pubhub.devnetcloud.com/media/dme-docs-10-2-2/docs/Routing%20and%20Forwarding/icmpv4:Dom/) | [nxos_icmpv4_vrf](https://registry.terraform.io/providers/CiscoDevNet/nxos/latest/docs/resources/icmpv4_vrf) | [nxos_icmpv4_vrf](https://registry.terraform.io/providers/CiscoDevNet/nxos/latest/docs/data-sources/icmpv4_vrf) |
 | [ipv4aclACL](https://pubhub.devnetcloud.com/media/dme-docs-10-2-2/docs/Security%20and%20Policing/ipv4acl:ACL/) | [nxos_ipv4_access_list](https://registry.terraform.io/providers/CiscoDevNet/nxos/latest/docs/resources/ipv4_access_list) | [nxos_ipv4_access_list](https://registry.terraform.io/providers/CiscoDevNet/nxos/latest/docs/data-sources/ipv4_access_list) |
 | [ipv4aclACE](https://pubhub.devnetcloud.com/media/dme-docs-10-2-2/docs/Security%20and%20Policing/ipv4acl:ACE/) | [nxos_ipv4_access_list_entry](https://registry.terraform.io/providers/CiscoDevNet/nxos/latest/docs/resources/ipv4_access_list_entry) | [nxos_ipv4_access_list_entry](https://registry.terraform.io/providers/CiscoDevNet/nxos/latest/docs/data-sources/ipv4_access_list_entry) |
 | [aclIf](https://pubhub.devnetcloud.com/media/dme-docs-10-2-2/docs/Security%20and%20Policing/acl:If/) | [nxos_ipv4_access_list_policy_egress_interface](https://registry.terraform.io/providers/CiscoDevNet/nxos/latest/docs/resources/ipv4_access_list_policy_egress_interface) | [nxos_ipv4_access_list_policy_egress_interface](https://registry.terraform.io/providers/CiscoDevNet/nxos/latest/docs/data-sources/ipv4_access_list_policy_egress_interface) |

diff --git a/docs/resources/icmpv4.md b/docs/resources/icmpv4.md
@@ -0,0 +1,50 @@
+---
+# generated by https://github.com/hashicorp/terraform-plugin-docs
+page_title: "nxos_icmpv4 Resource - terraform-provider-nxos"
+subcategory: "ICMP"
+description: |-
+  This resource can manage the global ICMP configuration.
+  API Documentation: icmpv4Entity https://pubhub.devnetcloud.com/media/dme-docs-10-2-2/docs/Routing%20and%20Forwarding/icmpv4:Entity/
+  Child resources
+  nxos_icmpv4_instance https://registry.terraform.io/providers/CiscoDevNet/nxos/latest/docs/resources/icmpv4_instance
+---
+
+# nxos_icmpv4 (Resource)
+
+This resource can manage the global ICMP configuration.
+
+- API Documentation: [icmpv4Entity](https://pubhub.devnetcloud.com/media/dme-docs-10-2-2/docs/Routing%20and%20Forwarding/icmpv4:Entity/)
+
+### Child resources
+
+- [nxos_icmpv4_instance](https://registry.terraform.io/providers/CiscoDevNet/nxos/latest/docs/resources/icmpv4_instance)
+
+## Example Usage
+
+```terraform
+resource "nxos_icmpv4" "example" {
+  admin_state = "enabled"
+}
+```
+
+<!-- schema generated by tfplugindocs -->
+## Schema
+
+### Optional
+
+- `admin_state` (String) Administrative state.
+  - Choices: `enabled`, `disabled`
+  - Default value: `enabled`
+- `device` (String) A device name from the provider configuration.
+
+### Read-Only
+
+- `id` (String) The distinguished name of the object.
+
+## Import
+
+Import is supported using the following syntax:
+
+```shell
+terraform import nxos_icmpv4.example "sys/icmpv4"
+```
diff --git a/docs/resources/icmpv4_instance.md b/docs/resources/icmpv4_instance.md
@@ -0,0 +1,56 @@
+---
+# generated by https://github.com/hashicorp/terraform-plugin-docs
+page_title: "nxos_icmpv4_instance Resource - terraform-provider-nxos"
+subcategory: "ICMP"
+description: |-
+  This resource can manage the global ICMP Instance configuration.
+  API Documentation: icmpv4Inst https://pubhub.devnetcloud.com/media/dme-docs-10-2-2/docs/Routing%20and%20Forwarding/icmpv4:Instance/
+  Parent resources
+  nxos_icmpv4 https://registry.terraform.io/providers/CiscoDevNet/nxos/latest/docs/resources/icmpv4
+  Child resources
+  nxos_icmpv4_domain https://registry.terraform.io/providers/CiscoDevNet/nxos/latest/docs/resources/icmpv4_domain
+---
+
+# nxos_icmpv4_instance (Resource)
+
+This resource can manage the global ICMP Instance configuration.
+
+- API Documentation: [icmpv4Inst](https://pubhub.devnetcloud.com/media/dme-docs-10-2-2/docs/Routing%20and%20Forwarding/icmpv4:Instance/)
+
+### Parent resources
+
+- [nxos_icmpv4](https://registry.terraform.io/providers/CiscoDevNet/nxos/latest/docs/resources/icmpv4)
+
+### Child resources
+
+- [nxos_icmpv4_domain](https://registry.terraform.io/providers/CiscoDevNet/nxos/latest/docs/resources/icmpv4_domain)
+
+## Example Usage
+
+```terraform
+resource "nxos_icmpv4_instance" "example" {
+  admin_state = "enabled"
+}
+```
+
+<!-- schema generated by tfplugindocs -->
+## Schema
+
+### Optional
+
+- `admin_state` (String) Administrative state.
+  - Choices: `enabled`, `disabled`
+  - Default value: `enabled`
+- `device` (String) A device name from the provider configuration.
+
+### Read-Only
+
+- `id` (String) The distinguished name of the object.
+
+## Import
+
+Import is supported using the following syntax:
+
+```shell
+terraform import nxos_icmpv4_instance.example "sys/icmpv4/inst"
+```
diff --git a/docs/resources/icmpv4_interface.md b/docs/resources/icmpv4_interface.md
@@ -0,0 +1,57 @@
+---
+# generated by https://github.com/hashicorp/terraform-plugin-docs
+page_title: "nxos_icmpv4_interface Resource - terraform-provider-nxos"
+subcategory: "ICMP"
+description: |-
+  This resource can manage the global ICMP Instance configuration.
+  API Documentation: icmpv4If https://pubhub.devnetcloud.com/media/dme-docs-10-2-2/docs/Routing%20and%20Forwarding/icmpv4:If/
+  Parent resources
+  nxos_icmpv4_vrf https://registry.terraform.io/providers/CiscoDevNet/nxos/latest/docs/resources/icmpv4_vrf
+---
+
+# nxos_icmpv4_interface (Resource)
+
+This resource can manage the global ICMP Instance configuration.
+
+- API Documentation: [icmpv4If](https://pubhub.devnetcloud.com/media/dme-docs-10-2-2/docs/Routing%20and%20Forwarding/icmpv4:If/)
+
+### Parent resources
+
+- [nxos_icmpv4_vrf](https://registry.terraform.io/providers/CiscoDevNet/nxos/latest/docs/resources/icmpv4_vrf)
+
+## Example Usage
+
+```terraform
+resource "nxos_icmpv4_interface" "example" {
+  vrf_name     = "VRF1"
+  interface_id = "vlan10"
+  control      = "port-unreachable"
+}
+```
+
+<!-- schema generated by tfplugindocs -->
+## Schema
+
+### Required
+
+- `interface_id` (String) Must match first field in the output of `show intf brief`. Example: `vlan100`.
+- `vrf_name` (String) VRF name.
+
+### Optional
+
+- `control` (String) ICMP interface control.
+  - Choices: `port-unreachable`, `unreachable`
+  - Default value: `unreachable`
+- `device` (String) A device name from the provider configuration.
+
+### Read-Only
+
+- `id` (String) The distinguished name of the object.
+
+## Import
+
+Import is supported using the following syntax:
+
+```shell
+terraform import nxos_icmpv4_interface.example "sys/icmpv4/inst/dom-[VRF1]/if-[vlan10]"
+```
diff --git a/docs/resources/icmpv4_vrf.md b/docs/resources/icmpv4_vrf.md
@@ -0,0 +1,57 @@
+---
+# generated by https://github.com/hashicorp/terraform-plugin-docs
+page_title: "nxos_icmpv4_vrf Resource - terraform-provider-nxos"
+subcategory: "ICMP"
+description: |-
+  This resource can manage the global ICMP Domain configuration.
+  API Documentation: icmpv4Dom https://pubhub.devnetcloud.com/media/dme-docs-10-2-2/docs/Routing%20and%20Forwarding/icmpv4:Dom/
+  Parent resources
+  nxos_icmpv4_instance https://registry.terraform.io/providers/CiscoDevNet/nxos/latest/docs/resources/icmpv4_instance
+  Child resources
+  nxos_icmpv4_interface https://registry.terraform.io/providers/CiscoDevNet/nxos/latest/docs/resources/icmpv4_interface
+---
+
+# nxos_icmpv4_vrf (Resource)
+
+This resource can manage the global ICMP Domain configuration.
+
+- API Documentation: [icmpv4Dom](https://pubhub.devnetcloud.com/media/dme-docs-10-2-2/docs/Routing%20and%20Forwarding/icmpv4:Dom/)
+
+### Parent resources
+
+- [nxos_icmpv4_instance](https://registry.terraform.io/providers/CiscoDevNet/nxos/latest/docs/resources/icmpv4_instance)
+
+### Child resources
+
+- [nxos_icmpv4_interface](https://registry.terraform.io/providers/CiscoDevNet/nxos/latest/docs/resources/icmpv4_interface)
+
+## Example Usage
+
+```terraform
+resource "nxos_icmpv4_vrf" "example" {
+  vrf_name = "VRF1"
+}
+```
+
+<!-- schema generated by tfplugindocs -->
+## Schema
+
+### Required
+
+- `vrf_name` (String) VRF name
+
+### Optional
+
+- `device` (String) A device name from the provider configuration.
+
+### Read-Only
+
+- `id` (String) The distinguished name of the object.
+
+## Import
+
+Import is supported using the following syntax:
+
+```shell
+terraform import nxos_icmpv4_vrf.example "sys/icmpv4/inst/dom-[VRF1]"
+```
diff --git a/examples/data-sources/nxos_icmp/data-source.tf b/examples/data-sources/nxos_icmp/data-source.tf
@@ -0,0 +1,2 @@
+data "nxos_icmp" "example" {
+}
diff --git a/examples/data-sources/nxos_icmp_domain/data-source.tf b/examples/data-sources/nxos_icmp_domain/data-source.tf
@@ -0,0 +1,2 @@
+data "nxos_icmp_domain" "example" {
+}
diff --git a/examples/data-sources/nxos_icmp_instance/data-source.tf b/examples/data-sources/nxos_icmp_instance/data-source.tf
@@ -0,0 +1,2 @@
+data "nxos_icmp_instance" "example" {
+}
diff --git a/examples/data-sources/nxos_icmp_interface/data-source.tf b/examples/data-sources/nxos_icmp_interface/data-source.tf
@@ -0,0 +1,4 @@
+data "nxos_icmp_interface" "example" {
+  domain_name  = "icmpv4dom1"
+  interface_id = "vlan10"
+}
diff --git a/examples/data-sources/nxos_icmpv4/data-source.tf b/examples/data-sources/nxos_icmpv4/data-source.tf
@@ -0,0 +1,2 @@
+data "nxos_icmpv4" "example" {
+}