Archived

This repository will be archived. It is superseeded by a newer, more simplified Easy IMM, based on a YAML Schema Model.

Easy IMM

This Module will be archived in September as I am no longer maintaining it. It is surperseeded above.

The two models were so different I didn't merge them here.

Easy IMM - Comprehensive example for Intersight

Examples are Shown in the Following Directories:

• policies
• pools
• profiles
• templates

The Structure of the YAML Files is very flexible. You can have all the YAML Data in a single file or you can have it in multiple individual folders like is shown in this module. The important part is that the data.utils_yaml_merge.model is configured to read the folders that you put the Data into.

Modify variables.auto.tfvars to match environment

variables.auto.tfvars contains Terraform variables that I felt fit better outside of the YAML Data Model. These variables should be configured to be unique to the deployment environment, but examples are shown for the Richfield environemnt in the module.

Notes for the variables.auto.tfvars

• endpoint: SaaS will by default be intersight.com. Available in the event of CVA or PVA deployments.
• moids_policies: Consume Policies from a Data Source instead of a Resource. This is helpful if you separate the policies module from profiles/templates.
• moids_pools: Consume Pools from a Data Source instead of a Resource. This is helpful if you seperate the pools Module from the policies module.
• tags: Not Required, but by default the version of the script is being flagged here.

YAML Schema Notes for Autocompletion, Help, and Error Validation:

If you would like to enable Autocompletion, Help Context, and Error Validation, (HIGHLY RECOMMENDED) perform the following configuration in Visual Studio Code.

Install the YAML extension by Red Hat

Extensions: Search for YAML and Select the 'YAML Language Support by Red Hat'

Add the YAML Schema's below to the Visual Studio Code Settings

Settings » Settings: Search for YAML:Schemas.

Click: Edit in settings.json

Configure the following in yaml.schemas

"https://raw.githubusercontent.com/terraform-cisco-modules/easy-imm-comprehensive-example/main/yaml_schemas/easy_imm.json": [
    "pools/*.yaml",
    "policies/*.yaml",
    "profiles/*.yaml",
    "templates/*.yaml"
],

Environment Variables

Terraform Cloud/Enterprise - Workspace Variables

• Add variable intersight_api_key_id with the value of [your-api-key]
• Add variable intersight_secret_key with the value of [your-secret-file-content]

Add Other Variables as discussed below based on use cases

Cloud Posse tfenv

Command line utility to transform environment variables for use with Terraform. (e.g. HOSTNAME → TF_VAR_hostname)

Recently I adopted the tfenv runner to standardize environment variables with multiple orchestration tools. tfenv makes it so you don't need to add TF_VAR_ to the variables when you add them to the environment. But it doesn't work for windows would be the caveat.

In the export examples below, for the Linux Example, the 'TF_VAR_' is excluded because Cloud Posse tfenv is used to insert it during the run.

Aliases for .bashrc

Additionally to Save time on typing commands I use the following aliases by editing the .bashrc for my environment.

alias tfa='tfenv terraform apply main.plan'
alias tfap='tfenv terraform apply -parallelism=1 main.plan'
alias tfd='terraform destroy'
alias tff='terraform fmt'
alias tfi='terraform init'
alias tfp='tfenv terraform plan -out=main.plan'
alias tfu='terraform init -upgrade'
alias tfv='terraform validate'

IMPORTANT: ALL EXAMPLES BELOW ASSUME USING tfenv in LINUX

Linux

export intersight_api_key_id="<your-api-key>"
export intersight_secret_key="<secret-key-file-location>"

Windows

$env:TF_VAR_intersight_api_key_id="<your-api-key>"
$env:TF_VAR_intersight_secret_key="<secret-key-file-location>"

Sensitive Variables for the Policies Module:

Certificate Management - FIAttached Servers

• cert_mgmt_certificate: Options are 1-5 for Up to 5 Certificates. Variable Should Point to the File Location of the PEM Certificate.
• cert_mgmt_private_key: Options are 1-5 for Up to 5 Private Keys. Variable Should Point to the File Location of the PEM Private Key.

Linux

export cert_mgmt_certificate_1='<cert_mgmt_certificate_file_location>'

export cert_mgmt_private_key_1='<cert_mgmt_private_key_file_location>'

Windows

$env:TF_VAR_cert_mgmt_certificate_1='<cert_mgmt_certificate_file_location>'

$env:TF_VAR_cert_mgmt_private_key_1='<cert_mgmt_private_key_file_location>'

Drive Security - KMIP Sensitive Variables

• drive_security_password: If Authentication is supported/used by the KMIP Server, This is the User Password to Configure.
• drive_security_server_ca_certificate: KMIP Server CA Certificate Contents.

Linux

export drive_security_password='<drive_security_password>'

export drive_security_server_ca_certificate='<drive_security_server_ca_certificate_file_location>'

Windows

$env:TF_VAR_drive_security_password='<drive_security_password>'

$env:TF_VAR_drive_security_server_ca_certificate='<drive_security_server_ca_certificate_file_location>'

Firmware - CCO Credentials

• cco_user: If Configuring Firmware Policies, the CCO User for Firmware Downloads.
• cco_password: If Configuring Firmware Policies, the CCO Password for Firmware Downloads.

Linux

export cco_user='<cco_user>'

export cco_password='<cco_password>'

Windows

$env:TF_VAR_cco_user='<cco_user>'

$env:TF_VAR_cco_password='<cco_password>'

IPMI/iSCSI/LDAP/Local Users/SNMP/Virtual Media

• ipmi_key_1: Currently IPMI isn't Working, I would Skip this for Now.
• iscsi_boot_password: If Configuring CHAP or MSCHAP Authentication, this is the User Password to Use.
• binding_parameters_password: Although You can use a binding password, highly recommend using login user credentials instead in the module.
• local_user_password_1-5: If Configuring Multiple Users, increment the Password based on number of configured Users.
• access_community_string_1-5: Used to Configure 1 or More Community Strings. Only used if assigned.
• snmp_auth_password_1-5: If Configuring 1 or More SNMP Users. Only used if assigned.
• snmp_privacy_password_1-5: If Configuring SNMP Users and security_level set to AuthPriv. Only used if assigned.
• snmp_trap_community_1-5: Used by SNMP Trap Servers if using v2c instead of v3.
• vmedia_password_1-5: If Configuring vMedia Mappings and method uses authentication.

Linux

export cco_user='<cco_user>'

export cco_password='<cco_password>'

Windows

$env:TF_VAR_cco_user='<cco_user>'

$env:TF_VAR_cco_password='<cco_password>'

Requirements

Providers

Modules

NOTE:

When the Data is merged from the YAML files, it will run through the modules using for_each loop(s). Sensitive Variables cannot be added to a for_each loop, instead use the variables below to add sensitive values for policies.

Inputs

Outputs

Sub Modules

If you want to see documentation on Variables for Submodules use the links below:

Terraform Registry

Policies

Policies

Pools

Pools

Profiles

Domain

Chassis and Server + Server Templates