From 3e22d70c5663276872f2d99ecd3d2b0ec7c6a706 Mon Sep 17 00:00:00 2001 From: scotttyso Date: Sun, 15 Aug 2021 14:40:50 -0400 Subject: [PATCH] documentation updates --- .../domain_uplink_lan_port_channel/README.md | 2 +- .../variables.tf | 2 +- modules/policies_snmp_2_users/variables.tf | 23 +++++++++---------- modules/server_profile/README.md | 6 ++--- modules/server_profile/variables.tf | 12 +++++----- 5 files changed, 22 insertions(+), 23 deletions(-) diff --git a/modules/domain_uplink_lan_port_channel/README.md b/modules/domain_uplink_lan_port_channel/README.md index 0c963ee..aa4f819 100644 --- a/modules/domain_uplink_lan_port_channel/README.md +++ b/modules/domain_uplink_lan_port_channel/README.md @@ -46,7 +46,7 @@ No modules. | [flow\_control\_moid](#input\_flow\_control\_moid) | A reference to a fabricFlowControlPolicy resource. | `set(string)` | `[]` | no | | [lan\_uplink\_pc\_id](#input\_lan\_uplink\_pc\_id) | Unique Identifier of the port-channel, local to this switch. | `string` | `49` | no | | [lan\_uplink\_pc\_ports](#input\_lan\_uplink\_pc\_ports) | List of Ports to Assign to the LAN Port-Channel Policy. | `set(string)` | 
[
  49,
  50
]
| no | -| [lan\_uplink\_speed](#input\_lan\_uplink\_speed) | Admin configured speed for the port.
* Auto - Admin configurable speed AUTO ( default ).
* 1Gbps - Admin configurable speed 1Gbps.
* 10Gbps - Admin configurable speed 10Gbps.
* 25Gbps - Admin configurable speed 25Gbps.
* 40Gbps - Admin configurable speed 40Gbps.
* 100Gbps - Admin configurable speed 100Gbps. | `string` | `"Auto"` | no | +| [lan\_uplink\_speed](#input\_lan\_uplink\_speed) | Admin configured speed for the port.
* Auto - Admin configurable speed Auto.
* 1Gbps - Admin configurable speed 1Gbps.
* 10Gbps - Admin configurable speed 10Gbps.
* 25Gbps - Admin configurable speed 25Gbps.
* 40Gbps - Admin configurable speed 40Gbps.
* 100Gbps - Admin configurable speed 100Gbps. | `string` | `"Auto"` | no | | [link\_aggregation\_moid](#input\_link\_aggregation\_moid) | A reference to a fabricLinkAggregationPolicy resource. | `set(string)` | `[]` | no | | [link\_control\_moid](#input\_link\_control\_moid) | A reference to a fabricLinkControlPolicy resource. | `set(string)` | `[]` | no | | [port\_policy\_moid](#input\_port\_policy\_moid) | A reference to a fabricPortPolicy resource. | `string` | n/a | yes | diff --git a/modules/domain_uplink_lan_port_channel/variables.tf b/modules/domain_uplink_lan_port_channel/variables.tf index e61ffd4..dd860fd 100644 --- a/modules/domain_uplink_lan_port_channel/variables.tf +++ b/modules/domain_uplink_lan_port_channel/variables.tf @@ -31,7 +31,7 @@ variable "lan_uplink_speed" { default = "Auto" description = <<-EOT Admin configured speed for the port. - * Auto - Admin configurable speed AUTO ( default ). + * Auto - Admin configurable speed Auto. * 1Gbps - Admin configurable speed 1Gbps. * 10Gbps - Admin configurable speed 10Gbps. * 25Gbps - Admin configurable speed 25Gbps. diff --git a/modules/policies_snmp_2_users/variables.tf b/modules/policies_snmp_2_users/variables.tf index 77a89b2..0388139 100644 --- a/modules/policies_snmp_2_users/variables.tf +++ b/modules/policies_snmp_2_users/variables.tf @@ -104,18 +104,6 @@ variable "tags" { type = list(map(string)) } -variable "v2_enabled" { - default = true - description = "State of the SNMPv2c on the endpoint. If enabled, the endpoint sends SNMPv2c properties to the designated host." - type = bool -} - -variable "v3_enabled" { - default = true - description = "State of the SNMPv3 on the endpoint. If enabled, the endpoint sends SNMPv3 properties to the designated host." - type = bool -} - variable "user_1_auth_password" { default = "" description = "Authorization password for the user." @@ -208,3 +196,14 @@ variable "user_2_security_level" { type = string } +variable "v2_enabled" { + default = true + description = "State of the SNMPv2c on the endpoint. If enabled, the endpoint sends SNMPv2c properties to the designated host." + type = bool +} + +variable "v3_enabled" { + default = true + description = "State of the SNMPv3 on the endpoint. If enabled, the endpoint sends SNMPv3 properties to the designated host." + type = bool +} diff --git a/modules/server_profile/README.md b/modules/server_profile/README.md index ec456b3..874fd64 100644 --- a/modules/server_profile/README.md +++ b/modules/server_profile/README.md @@ -42,15 +42,15 @@ No modules. | Name | Description | Type | Default | Required | |------|-------------|------|---------|:--------:| -| [action](#input\_action) | Action to Perform on the Chassis Profile Assignment. Options are:
* Deploy
* No-op
* Unassign | `string` | `"No-op"` | no | +| [action](#input\_action) | Action to Perform on the Chassis Profile Assignment. Options are:
* Deploy
* No-op
* Unassign | `string` | `"No-op"` | no | | [assigned\_server](#input\_assigned\_server) | A reference to a computePhysical resource. | `list(map(string))` | `[]` | no | -| [description](#input\_description) | Description for the Policy. | `string` | `""` | no | +| [description](#input\_description) | Description to Assign to the Profile. | `string` | `""` | no | | [name](#input\_name) | Name for the Profile. | `string` | `"server_profile"` | no | | [org\_moid](#input\_org\_moid) | Intersight Organization moid. | `string` | n/a | yes | | [policy\_bucket](#input\_policy\_bucket) | List of Policies to Assign to the Profile. | `list(map(string))` | `[]` | no | | [src\_template](#input\_src\_template) | A reference to a policyAbstractProfile resource.. | `set(string)` | `[]` | no | | [tags](#input\_tags) | List of Tag Attributes to Assign to the Policy. | `list(map(string))` | `[]` | no | -| [target\_platform](#input\_target\_platform) | The platform for which the server profile is applicable. It can either be a server that is operating in standalone mode or which is attached to a Fabric Interconnect managed by Intersight.
* FIAttached - Servers which are connected to a Fabric Interconnect that is managed by Intersight.
* Standalone - Servers which are operating in standalone mode i.e. not connected to a Fabric Interconnected. | `string` | `"FIAttached"` | no | +| [target\_platform](#input\_target\_platform) | The platform for which the server profile is applicable. It can either be a server that is operating in standalone mode or which is attached to a Fabric Interconnect managed by Intersight.
* FIAttached - Servers which are connected to a Fabric Interconnect that is managed by Intersight.
* Standalone - Servers which are operating in standalone mode i.e. not connected to a Fabric Interconnected. | `string` | `"FIAttached"` | no | | [type](#input\_type) | Defines the type of the profile. Accepted values are:
* instance
* template | `string` | `"instance"` | no | | [wait\_for\_completion](#input\_wait\_for\_completion) | This model object can trigger workflows. Use this option to wait for all running workflows to reach a complete state. | `bool` | `false` | no | diff --git a/modules/server_profile/variables.tf b/modules/server_profile/variables.tf index 7f4cf49..d6be9cd 100644 --- a/modules/server_profile/variables.tf +++ b/modules/server_profile/variables.tf @@ -7,9 +7,9 @@ variable "action" { default = "No-op" description = <<-EOT Action to Perform on the Chassis Profile Assignment. Options are: - * Deploy - * No-op - * Unassign + * Deploy + * No-op + * Unassign EOT type = string } @@ -22,7 +22,7 @@ variable "assigned_server" { variable "description" { default = "" - description = "Description for the Policy." + description = "Description to Assign to the Profile." type = string } @@ -59,8 +59,8 @@ variable "target_platform" { default = "FIAttached" description = <<-EOT The platform for which the server profile is applicable. It can either be a server that is operating in standalone mode or which is attached to a Fabric Interconnect managed by Intersight. - * FIAttached - Servers which are connected to a Fabric Interconnect that is managed by Intersight. - * Standalone - Servers which are operating in standalone mode i.e. not connected to a Fabric Interconnected. + * FIAttached - Servers which are connected to a Fabric Interconnect that is managed by Intersight. + * Standalone - Servers which are operating in standalone mode i.e. not connected to a Fabric Interconnected. EOT type = string }