Dell Technologies – Resources

V1.2.3: ome_appliance_network resource

Mon, 01 Jan 0001 00:00:00 +0000

ome_appliance_network (Resource)

This terraform resource is used to manage Appliance Network Settings on OME.We can Create, Update and Delete OME Appliance Network Settings using this resource.

~> Note: Exactly one of ref_template_name and ref_template_id and exactly one of device_ids and device_servicetags are required.

~> Note: When schedule is true, following parameters are considered: notify_on_schedule, cron, email_addresses, output_format.

~> Note: Updates are supported for all the parameters.

Example Usage

resource "ome_appliance_network" "net1" {
  // to change the ome appliance time setting
  time_setting = {
    # Required Attribute
    time_zone = "TZ_ID_65"

    # Optional Attribute
    enable_ntp             = true
    primary_ntp_address    = "1.0.0.0"
    secondary_ntp_address1 = "2.0.0.0"
    secondary_ntp_address2 = "3.0.0.0"
  }
  // to change the ome appliance session setting
  session_setting = {
    enable_universal_timeout = true
    universal_timeout        = 20
    # configuring number of parallel session 
    api_session = 10
    gui_session = 11
  }
  // to change the ome appliance time setting
  proxy_setting = {
    # Required Attribute
    enable_proxy = true

    # Optional Attribute
    # ip address and port is required when enable proxy is true 
    ip_address            = "1.0.0.1"
    proxy_port            = 443
    enable_authentication = true
    # username and password is required when enable authentication is true 
    username = "root"
    password = "root"
  }
  // to change the ome appliance adapter setting
  adapter_setting = {
    # Required Attributes
    enable_nic     = true
    interface_name = "ens160"

    # Optional Attributes
    reboot_delay = 0
    management_vlan = {
      # Required Attribute
      enable_vlan = false
    }
    ipv6_configuration = {
      # Required Attribute
      enable_ipv6 = true

      # Optional Attribute
      enable_auto_configuration = true
    }
    dns_configuration = {
      register_with_dns = false
    }
  }
}

# session setting without universal_timeout
resource "ome_appliance_network" "net2" {
  // to change the ome appliance session setting
  session_setting = {
    # configuring timeout attributes
    enable_universal_timeout = false
    api_timeout              = 20
    gui_timeout              = 20
    # configuring number of parallel session 
    api_session = 10
    gui_session = 11
  }
}

# static IP adapter setting 
resource "ome_appliance_network" "net3" {
  adapter_setting = {
    # Requried Attribute 
    enable_nic     = true
    interface_name = "ens160"

    # Optional Attribute
    reboot_delay = 0
    ipv6_configuration = {
      # Required Attribute
      enable_ipv6 = true

      # Optional Attribute
      enable_auto_configuration = false
      # static ipv6 configuration
      static_ip_address    = "<static-ipv6>"
      static_gateway       = "<static-ipv6-gateway>"
      static_prefix_length = 64
      # static dns configuration
      use_dhcp_for_dns_server_names = false
      static_preferred_dns_server   = "<dns-server-1>"
      static_alternate_dns_server   = "<dns-server-2>"
    }

    ipv4_configuration = {
      # Required Attribute
      enable_ipv4 = true

      # Optional Attribute
      enable_dhcp = false
      # static ipv4 configuration
      static_ip_address  = "10.10.10.10"
      static_subnet_mask = "255.255.255.0"
      static_gateway     = "10.10.10.1"
      # static dns configuration
      use_dhcp_for_dns_server_names = false
      static_alternate_dns_server   = "10.10.10.2"
      static_preferred_dns_server   = "10.10.10.3"
    }
  }
}

After the execution of above resource block, network setting would have been applied on the OME. For more information, Please check the terraform state file.

Schema

Optional

adapter_setting (Attributes) Ome Adapter Setting (see below for nested schema)
proxy_setting (Attributes) Ome Proxy Setting (see below for nested schema)
session_setting (Attributes) Ome Session Setting (see below for nested schema)
time_setting (Attributes) Ome Time Setting (see below for nested schema)

Read-Only

id (String) ID of the ome network setting.

Nested Schema for `adapter_setting`

Required:

enable_nic (Boolean) Enable or disable Network Interface Card (NIC) configuration
interface_name (String) If there are multiple interfaces, network configuration changes can be applied to a single interface using the interface name of the NIC.

Optional:

dns_configuration (Attributes) Domain Name System(DNS) settings (see below for nested schema)
ipv4_configuration (Attributes) IPv4 network configuration. (Warning) Ensure that you have an alternate interface to access OpenManage Enterprise as these options can change the current IPv4 address (see below for nested schema)
ipv6_configuration (Attributes) IPv6 network configuration. (Warning) Ensure that you have an alternate interface to access OpenManage Enterprise as these options can change the current IPv6 address (see below for nested schema)
job_id (Number) Job ID
management_vlan (Attributes) vLAN configuration. settings are applicable for OpenManage Enterprise Modular (see below for nested schema)
reboot_delay (Number) The time in seconds, after which settings are applied

Nested Schema for `adapter_setting.dns_configuration`

Optional:

dns_domain_name (String) Static DNS domain name. This is applicable when “use_dhcp_for_dns_domain_name” is false.
dns_name (String) DNS name for “hostname”. This is applicable when “register_with_dns” is true.
register_with_dns (Boolean) Register/Unregister I(dns_name) on the DNS Server.This option cannot be updated if vLAN configuration changes.
use_dhcp_for_dns_server_names (Boolean) Get the “dns_domain_name” using a DHCP server.

Nested Schema for `adapter_setting.ipv4_configuration`

Required:

enable_ipv4 (Boolean) Enable or disable access to the network using IPv4.

Optional:

enable_dhcp (Boolean) Enable or disable the automatic request to get an IPv4 address from the IPv4 Dynamic Host Configuration Protocol (DHCP) server. If enable_dhcp option is true, OpenManage Enterprise retrieves the IP configuration—IPv4 address, subnet mask, and gateway from a DHCP server on the existing network.
static_alternate_dns_server (String) Static IPv4 DNS alternate server. This option is applicable when “use_dhcp_for_dns_server_names” is false.
static_gateway (String) Static IPv4 gateway address. This option is applicable when “enable_dhcp” is false.
static_ip_address (String) Static IPv4 address. This option is applicable when “enable_dhcp” is false.
static_preferred_dns_server (String) Static IPv4 DNS preferred server. This option is applicable when “use_dhcp_for_dns_server_names” is false.
static_subnet_mask (String) Static IPv4 subnet mask address. This option is applicable when “enable_dhcp” is false.
use_dhcp_for_dns_server_names (Boolean) This option allows to automatically request and obtain a DNS server IPv4 address from the DHCP server. This option is applicable when “enable_dhcp” is true.

Nested Schema for `adapter_setting.ipv6_configuration`

Required:

enable_ipv6 (Boolean) Enable or disable access to the network using the IPv6.

Optional:

enable_auto_configuration (Boolean) Enable or disable the automatic request to get an IPv6 address from the IPv6 DHCP server or router advertisements(RA). If “enable_auto_configuration” is true, OME retrieves IP configuration-IPv6 address, prefix, and gateway, from a DHCPv6 server on the existing network
static_alternate_dns_server (String) Static IPv6 DNS alternate server. This option is applicable when “use_dhcp_for_dns_server_names” is false.
static_gateway (String) Static IPv6 gateway address. This option is applicable when “enable_auto_configuration” is false.
static_ip_address (String) Static IPv6 address. This option is applicable when “enable_auto_configuration” is false.
static_preferred_dns_server (String) Static IPv6 DNS preferred server. This option is applicable when “use_dhcp_for_dns_server_names” is false.
static_prefix_length (Number) Static IPv6 prefix length. This option is applicable when “enable_auto_configuration” is false.
use_dhcp_for_dns_server_names (Boolean) This option allows to automatically request and obtain a DNS server IPv6 address from the DHCP server. This option is applicable when “enable_auto_configuration” is true.

Nested Schema for `adapter_setting.management_vlan`

Required:

enable_vlan (Boolean) Enable or disable vLAN for management.The vLAN configuration cannot be updated if the “register_with_dns” field under “dns_configuration” is true. WARNING: Ensure that the network cable is plugged to the correct port after the vLAN configurationchanges have been made. If not, the configuration change may not be effective.

Optional:

id (Number) vLAN ID. This option is applicable when “enable_vlan” is true.

Nested Schema for `proxy_setting`

Required:

enable_proxy (Boolean) Enables or disables the HTTP proxy configuration. If “enable proxy” is false, then the HTTP proxy configuration is set to its default value.

Optional:

enable_authentication (Boolean) Enable or disable proxy authentication. If “enable_authentication” is true, “proxy_username” and “proxy_password” must be provided. If “enable_authentication” is false, the proxy username and password are set to its default values.
ip_address (String) Proxy server address. This option is mandatory when “enable_proxy” is true.
password (String) Proxy server password. This option is mandatory when “enable_authentication” is true.
proxy_port (Number) Proxy server’s port number. This option is mandatory when “enable_proxy” is true.
username (String) Proxy server username. This option is mandatory when “enable_authentication” is true.

Nested Schema for `session_setting`

Optional:

api_session (Number) The maximum number of API sessions to be allowed.
api_timeout (Number) Duration of inactivity in minutes after which the API session ends. This is mutually exclusive with “universal_timeout”.
enable_universal_timeout (Boolean) Enable or disable the universal inactivity timeout.
gui_session (Number) The maximum number of GUI sessions to be allowed.
gui_timeout (Number) Duration of inactivity in minutes after which the web interface of Graphical User Interface (GUI) session ends. This is mutually exclusive with “universal_timeout”.
serial_session (Number) The maximum number of serial console sessions to be allowed. This is applicable only for OpenManage Enterprise Modular.
serial_timeout (Number) Duration of inactivity in minutes after which the serial console session ends.This is applicable only for OpenManage Enterprise Modular. This is mutually exclusive with “universal_timeout”.
ssh_session (Number) The maximum number of SSH sessions to be allowed. This is applicable to OME-M only.
ssh_timeout (Number) Duration of inactivity in minutes after which the SSH session ends. This is applicable only for OpenManage Enterprise Modular. This is mutually exclusive with “universal_timeout”.
universal_timeout (Number) Duration of inactivity in minutes after which all sessions end. This is applicable when “enable_universal_timeout” is true. This is mutually exclusive with “api_timeout”, “gui_timeout”, “ssh_timeout” and “serial_timeout”.

Nested Schema for `time_setting`

Required:

time_zone (String) The valid timezone ID to be used. This option is applicable for both system time and NTP time synchronization.

Optional:

enable_ntp (Boolean) Enables or disables Network Time Protocol(NTP).If “enable_ntp” is false, then the NTP addresses reset to their default values.
primary_ntp_address (String) The primary NTP address. This option is applicable when “enable_ntp” is true.
secondary_ntp_address1 (String) The first secondary NTP address. This option is applicable when “enable_ntp” is true.
secondary_ntp_address2 (String) The second secondary NTP address. This option is applicable when “enable_ntp” is true.
system_time (String) Time in the current system. This option is only applicable when “enable_ntp” is false. This option must be provided in following format ‘yyyy-mm-dd hh:mm:ss’.

V1.2.3: ome_application_certificate resource

Mon, 01 Jan 0001 00:00:00 +0000

ome_application_certificate (Resource)

This terraform resource is used to upload certificate to OME.

~> Note: Exactly one of ref_template_name and ref_template_id and exactly one of device_ids and device_servicetags are required.

~> Note: When schedule is true, following parameters are considered: notify_on_schedule, cron, email_addresses, output_format.

~> Note: Updates are supported for all the parameters.

Example Usage

/*
Copyright (c) 2024 Dell Inc., or its subsidiaries. All Rights Reserved.
Licensed under the Mozilla Public License Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
    http://mozilla.org/MPL/2.0/
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

data "local_file" "cert" {
  # this is the path to the certificate that we want to upload.
  filename = "./signed-certificate.pem.crt"
}

resource "ome_application_certificate" "ome_cert" {
  certificate_base64 = data.local_file.cert.content_base64
}

After the execution of above resource block, certificate would have been uploaded on the OME. For more information, Please check the terraform state file.

Schema

Required

certificate_base64 (String) Base64 encoded certificate. Terraform will replace (delete and recreate) this resource if this attribute is modified.

Read-Only

id (String) ID for application Cert resource.

V1.2.3: ome_application_csr resource

Mon, 01 Jan 0001 00:00:00 +0000

ome_application_csr (Resource)

This terraform resource is used to generate application Certificate Signing Request from OME.

~> Note: Exactly one of ref_template_name and ref_template_id and exactly one of device_ids and device_servicetags are required.

~> Note: When schedule is true, following parameters are considered: notify_on_schedule, cron, email_addresses, output_format.

~> Note: Updates are supported for all the parameters.

Example Usage

/*
Copyright (c) 2024 Dell Inc., or its subsidiaries. All Rights Reserved.
Licensed under the Mozilla Public License Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
    http://mozilla.org/MPL/2.0/
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

resource "ome_application_csr" "csr1" {
  specs = {
    distinguished_name      = "localhost"
    department_name         = "Terraform Server Solutions"
    business_name           = "Dell Terraform"
    locality                = "RedRock"
    state                   = "Texas"
    country                 = "US"
    email                   = "noreply@gmail.com"
    subject_alternate_names = ["dell.com", "amer.dell.com", "10.36.0.124", "2607:f2b1:f006:127::10"]
  }
}

resource "local_file" "csr_file" {
  content  = ome_application_csr.csr
  filename = "foo.pem"
}

After the execution of above resource block, Certificate Signin Request would have been created on the OME. For more information, Please check the terraform state file.

Schema

Required

specs (Attributes) CSR specifications. Terraform will replace (delete and recreate) this resource if this attribute is modified. (see below for nested schema)

Read-Only

csr (String) CSR in single line PEM format returned from OME.
id (String) ID for application csr resource.

Nested Schema for `specs`

Required:

business_name (String) Business Name.
country (String) Country of the business.
department_name (String) Department Name.
distinguished_name (String) Distinguished Name.
email (String) Email address.
locality (String) Locality of the business.
state (String) State of the business.

Optional:

subject_alternate_names (List of String) Subject Alternate names. Maximum 4.

V1.2.3: ome_configuration_baseline resource

Mon, 01 Jan 0001 00:00:00 +0000

ome_configuration_baseline (Resource)

This terraform resource is used to manage configuration baseline entity of OME. We can Create, Update and Delete the OME configuration baseline using this resource. We can also do an ‘Import’ an existing ‘configuration baseline’ from OME .

~> Note: Exactly one of ref_template_name and ref_template_id and exactly one of device_ids and device_servicetags are required.

~> Note: When schedule is true, following parameters are considered: notify_on_schedule, cron, email_addresses, output_format.

~> Note: Updates are supported for all the parameters.

Example Usage

/*
Copyright (c) 2024 Dell Inc., or its subsidiaries. All Rights Reserved.
Licensed under the Mozilla Public License Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
    http://mozilla.org/MPL/2.0/
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

# Manage baseline using Device Servicetags
resource "ome_configuration_baseline" "baseline_name" {
  baseline_name      = "Baseline Name"
  device_servicetags = ["MXL1234", "MXL1235"]
}

# Create Baseline using device ids
resource "ome_configuration_baseline" "baseline1" {
  baseline_name   = "baseline1"
  ref_template_id = 745
  device_ids      = [10001, 10002]
  description     = "baseline description"
}


# Create Baseline using device servicetag with daily notification scheduled 
resource "ome_configuration_baseline" "baseline2" {
  baseline_name      = "baseline2"
  ref_template_id    = 745
  device_servicetags = ["MXL1234", "MXL1235"]
  description        = "baseline description"
  schedule           = true
  notify_on_schedule = true
  email_addresses    = ["test@testmail.com"]
  cron               = "0 30 11 * * ? *"
  output_format      = "csv"
}


# Create Baseline using device ids with daily notification on status changing to non-compliant 
resource "ome_configuration_baseline" "baseline3" {
  baseline_name   = "baseline3"
  ref_template_id = 745
  device_ids      = [10001, 10002]
  description     = "baseline description"
  schedule        = true
  email_addresses = ["test@testmail.com"]
  output_format   = "pdf"
}

After the execution of above resource block, configuration baseline template would have been created on the OME. For more information, Please check the terraform state file.

Schema

Required

baseline_name (String) Name of the Baseline.

Optional

cron (String) Cron expression for notification schedule. Can be set only when both schedule and notify_on_schedule are set to true.
description (String) Description of the baseline.
device_ids (Set of Number) List of the device id on which the baseline compliance needs to be run. Conflicts with device_servicetags.
device_servicetags (Set of String) List of the device servicetag on which the baseline compliance needs to be run. Conflicts with device_ids.
email_addresses (Set of String) Email addresses for notification. Can be set only when schedule is true.
job_retry_count (Number) Number of times the job has to be polled to get the final status of the resource. Default value is 30.
notify_on_schedule (Boolean) Schedule notification via cron or any time the baseline becomes non-compliant. Default value is false.
output_format (String) Output format type, the input is case senitive. Valid values are html, csv, pdfand xls. Default value is html.
ref_template_id (Number) Reference template ID. Conflicts with ref_template_name.
ref_template_name (String) Reference template name. Conflicts with ref_template_id.
schedule (Boolean) Schedule notification via email. Default value is false.
sleep_interval (Number) Sleep time interval for job polling in seconds. Default value is 20.

Read-Only

id (Number) ID of the configuration baseline resource.
task_id (Number) Task id associated with baseline.

Import

Import is supported using the following syntax:

# /*
# Copyright (c) 2024 Dell Inc., or its subsidiaries. All Rights Reserved.
# Licensed under the Mozilla Public License Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#     http://mozilla.org/MPL/2.0/
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
# */

terraform import ome_configuration_baseline.create_baseline "<existing_baseline_name>"

V1.2.3: ome_configuration_compliance resource

Mon, 01 Jan 0001 00:00:00 +0000

ome_configuration_compliance (Resource)

This terraform resource is used to manage configuration baseline remediations entity of OME. We can Create, Update and Delete the OME configuration baseline remediations using this resource.

~> Note: Exactly one of ref_template_name and ref_template_id and exactly one of device_ids and device_servicetags are required.

~> Note: When schedule is true, following parameters are considered: notify_on_schedule, cron, email_addresses, output_format.

~> Note: Updates are supported for all the parameters.

Example Usage

/*
Copyright (c) 2024 Dell Inc., or its subsidiaries. All Rights Reserved.
Licensed under the Mozilla Public License Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
    http://mozilla.org/MPL/2.0/
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

# remediate baseline for the specified target devices 
resource "ome_configuration_compliance" "remeditation0" {
  baseline_name = "baseline_name"
  target_devices = [
    {
      device_service_tag = "MX12345"
      compliance_status  = "Compliant"
    }
  ]
}

# remediate baseline for the specified target devices with scheduling
resource "ome_configuration_compliance" "remeditation1" {
  baseline_name = "baseline_name"
  target_devices = [
    {
      device_service_tag = "MX12345"
      compliance_status  = "Compliant"
    }
  ]
  run_later = true
  cron      = "0 00 11 14 02 ? 2032"
}

# Manage a baseline and also remediate it
# create baseline 
resource "ome_configuration_baseline" "baseline" {
  baseline_name      = var.baselinename
  ref_template_name  = "Mytemplate"
  device_servicetags = ["MX12345"]
  description        = "baseline description"
}

# create a compliance resource from above baseline
resource "ome_configuration_compliance" "remeditation" {
  baseline_name = var.baselinename
  target_devices = [
    {
      device_service_tag = "MX12345"
      compliance_status  = "Compliant"
    }
  ]
  depends_on = [
    ome_configuration_baseline.baseline
  ]
}

After the execution of above resource block, devices would have been compliant with template on the OME. For more information, Please check the terraform state file.

Schema

Required

target_devices (Attributes Set) Target devices to be remediated. (see below for nested schema)

Optional

baseline_id (Number) Id of the Baseline. Cannot be updated.
baseline_name (String) Name of the Baseline. Cannot be updated.
cron (String) Cron to schedule the remediation task.
job_retry_count (Number) Number of times the job has to be polled to get the final status of the resource. Default value is 30.
run_later (Boolean) Provides options to schedule the remediation task immediately, or at a specified time.
sleep_interval (Number) Sleep time interval for job polling in seconds. Default value is 20.

Read-Only

id (String) ID of the configuration compliance resource.

Nested Schema for `target_devices`

Required:

compliance_status (String) End compliance status of the target device, used to check the drifts in the compliance status. Valid values are Compliant.
device_service_tag (String) Target device servicetag to be remediated.

V1.2.3: ome_deployment resource

Mon, 01 Jan 0001 00:00:00 +0000

ome_deployment (Resource)

This terraform resource is used to manage template deployment entity of OME. We can Create, Update and Delete the OME Deployments using this resource. We can also do an ‘Import’ an existing ‘Deployment’ from OME .

~> Note: Atleast one of ref_template_name and ref_template_id and exactly one of device_ids and device_servicetags are required.

Example Usage

/*
Copyright (c) 2024 Dell Inc., or its subsidiaries. All Rights Reserved.
Licensed under the Mozilla Public License Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
    http://mozilla.org/MPL/2.0/
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

# Deploy template using Device Service tags
resource "ome_deployment" "deploy-template-1" {
  template_name      = "deploy-template-1"
  device_servicetags = ["MXL1234", "MXL1235"]
  job_retry_count    = 30
  sleep_interval     = 10
}

# Deploy template using Device Id's
resource "ome_deployment" "deploy-template-2" {
  template_name = "deploy-template-2"
  device_ids    = [10001, 10002]
}

# Get Deviceid's or servicetags from a specified list of groups
data "ome_groupdevices_info" "gd" {
  device_group_names = ["WINDOWS"]
}

# Deploy template for group by fetching the device ids using data sources
resource "ome_deployment" "deploy-template-3" {
  template_name = "deploy-template-3"
  device_ids    = data.ome_groupdevices_info.gd.device_ids
}

# Deploy template using Device Service tags with Schedule
resource "ome_deployment" "deploy-template-4" {
  template_name      = "deploy-template-4"
  device_servicetags = ["MXL1234"]
  run_later          = true
  cron               = "0 45 12 19 10 ? 2022"
}

# Deploy template using Device ids and deploy device attributes
resource "ome_deployment" "deploy-template-5" {
  template_name = "deploy-template-5"
  device_ids    = [10001, 10002]
  device_attributes = [
    {
      device_servicetags = ["MXL12345", "MXL23456"]
      attributes = [
        {
          attribute_id = 1197967
          display_name = "ServerTopology 1 Aisle Name"
          value        = "aisle updated value"
          is_ignored   = false
        }
      ]
    }
  ]
}

# Deploy template using Device ids and boot to network iso
resource "ome_deployment" "deploy-template-6" {
  template_name = "deploy-template-6"
  device_ids    = [10001, 10002]
  boot_to_network_iso = {
    boot_to_network = true
    share_type      = "CIFS"
    iso_timeout     = 240
    iso_path        = "/cifsshare/unattended/unattended_rocky8.6.iso"
    share_detail = {
      ip_address = "192.168.0.2"
      share_name = ""
      work_group = ""
      user       = "username"
      password   = "password"
    }
  }
  job_retry_count = 30
}

# Deploy template using Device ids by changing the job_retry_count and sleep_interval and ignore the same during updates
resource "ome_deployment" "deploy-template-7" {
  device_servicetags = ["MXL1234"]
  job_retry_count    = 30
  sleep_interval     = 10

  lifecycle {
    ignore_changes = [
      job_retry_count,
      sleep_interval
    ]
  }
}

# Deploy template using Device service tags and groupnames
resource "ome_deployment" "deploy-template-8" {
  template_id        = 614
  device_servicetags = concat(data.ome_groupdevices_info.gd.device_servicetags, ["MXL1235"])
}

After the execution of above resource block, template deployment would have been finished on the OME. For more information, Please check the terraform state file.

Schema

Optional

boot_to_network_iso (Object) Boot To Network ISO deployment details. (see below for nested schema)
cron (String) Cron to schedule the deployment task. Cron expression should be of future datetime.
device_attributes (List of Object) List of template attributes associated with the target devices for deploymnent. (see below for nested schema)
device_ids (Set of Number) List of the device id(s). Conflicts with device_servicetags.
device_servicetags (Set of String) List of the device servicetags. Conflicts with device_ids.
forced_shutdown (Boolean) Force shutdown after deployment.
job_retry_count (Number) Number of times the job has to be polled to get the final status of the resource. Default value is 20.
options_continue_on_warning (Boolean) Continue to run the job on warnings.
options_precheck_only (Boolean) Option to precheck
options_strict_checking_vlan (Boolean) Checks the strict association of vlan.
options_time_to_wait_before_shutdown (Number) Option to specify the time to wait before shutdown in seconds. Default and minimum value is 300 and maximum is 3600 seconds respectively. Default value is 300.
power_state_off (Boolean) End power state of a target devices. Default power state is ON. Make it true to switch it to OFF state.
run_later (Boolean) Provides options to schedule the deployment task immediately, or at a specified time.
sleep_interval (Number) Sleep time interval for job polling in seconds. Default value is 60.
template_id (Number) ID of the existing template. If a template with this ID is found, template_name will be ignored. Cannot be updated.
template_name (String) Name of the existing template. Cannot be updated.

Read-Only

id (String) ID of the deploy resource.

Nested Schema for `boot_to_network_iso`

Optional:

boot_to_network (Boolean)
iso_path (String)
iso_timeout (Number)
share_detail (Object) (see below for nested schema)
share_type (String)

Nested Schema for `boot_to_network_iso.share_detail`

Optional:

ip_address (String)
password (String)
share_name (String)
user (String)
work_group (String)

Nested Schema for `device_attributes`

Optional:

attributes (List of Object) (see below for nested schema)
device_servicetags (Set of String)

Nested Schema for `device_attributes.attributes`

Optional:

attribute_id (Number)
display_name (String)
is_ignored (Boolean)
value (String)

Import

Import is supported using the following syntax:

# /*
# Copyright (c) 2024 Dell Inc., or its subsidiaries. All Rights Reserved.
# Licensed under the Mozilla Public License Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#     http://mozilla.org/MPL/2.0/
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
# */

terraform import ome_deployment.deploy-template-3 "<existing_deployment_name>"

V1.2.3: ome_device_action resource

Mon, 01 Jan 0001 00:00:00 +0000

ome_device_action (Resource)

This terraform resource is used to run actions on devices managed by OME. The only supported action, for now, is refreshing inventory. This resource creates a job in OME to run the actions and does not support updating in-place. The resource generates a recreation plan instead for any necessary update action.

~> Note: Exactly one of ref_template_name and ref_template_id and exactly one of device_ids and device_servicetags are required.

~> Note: When schedule is true, following parameters are considered: notify_on_schedule, cron, email_addresses, output_format.

~> Note: Updates are supported for all the parameters.

Example Usage

# /*
# Copyright (c) 2024 Dell Inc., or its subsidiaries. All Rights Reserved.
# Licensed under the Mozilla Public License Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#     http://mozilla.org/MPL/2.0/
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
# */

# Use the device datasource to get the ids of the required devices
# Their ids shall be used to run actions on them
data "ome_device" "devs" {
  filters = {
    device_service_tags = ["CZMC1T2", "4111H63"]
  }
}

# refresh inventory of devices immediately on apply
# The resource creation will fail if the inventory refresh job fails or doesnt complete within `timeout` in minutes (here 8 minutes).
resource "ome_device_action" "code_1" {
  device_ids      = data.ome_device.devs.devices[*].id
  action          = "inventory_refresh"
  job_name        = "inventory-refresh-job"
  job_description = "Job to refresh inventory of CZMC1T2 and 4111H63 devices"
  timeout         = 8
  lifecycle {
    ignore_changes = [
      timeout,
    ]
  }
}

# refresh inventory of devices sometime in the future
# The resource creation succeeds when the job is created on OME
resource "ome_device_action" "code_2" {
  device_ids      = data.ome_device.devs.devices[*].id
  action          = "inventory_refresh"
  job_name        = "inventory-refresh-job-cron"
  job_description = "Job to refresh inventory of CZMC1T2 and 4111H63 devices in future"
  cron            = "0 * */10 * * ? *"
}

# Rerunning the same action is done by forcing recreation of the resource
# Option 1: Taint the resource 
#     https://developer.hashicorp.com/terraform/cli/commands/taint
# Option 2: From Terraform 1.5, one can use the -replace directive 
#     https://developer.hashicorp.com/terraform/cli/commands/plan#replace-address
# Option 3 (shown below): From Terraform 1.2, one can use the replace-triggered-by lifecycle method 
#     https://developer.hashicorp.com/terraform/language/meta-arguments/lifecycle#replace_triggered_by


# In below example, changing the string firmware_v1 to firmware_v2 will rerun the action
resource "terraform_data" "devices_firmware" {
  input = "firmware_v1"
}

resource "ome_device_action" "code_3" {
  device_ids      = data.ome_device.devs.devices[*].id
  action          = "inventory_refresh"
  job_name        = "inventory-refresh-job"
  job_description = "Job to refresh inventory of CZMC1T2 and 4111H63 devices when any of their firwares is upgraded"
  timeout         = 8
  lifecycle {
    ignore_changes = [
      timeout,
    ]
    # From Terraform 1.2, one can use the replace-triggered-by lifecycle method 
    # https://developer.hashicorp.com/terraform/language/meta-arguments/lifecycle#replace_triggered_by
    replace_triggered_by = [
      terraform_data.devices_firmware
    ]
  }
}

After the execution of above resource block, device action would have been initiated on the OME. For more information, Please check the terraform state file.

Schema

Required

device_ids (List of Number) List of id of devices on whom the action would be carried out.
job_name (String) Name of the job to be created on the OME appliance that will run the action.

Optional

action (String) Action to be performed on the devices. Accepted values are [inventory_refresh]. Default value is inventory_refresh.
cron (String) Cron expression to schedule an action in the future. If not specified, the action runs immediately on apply. Conflicts with timeout.
job_description (String) Description of the job to be created on the OME appliance that will run the action.
timeout (Number) Timeout, in minutes, for monitoring an immediately running action. Conflicts with cron. Default value is 10.

Read-Only

current_status (String) Current status of the job.
end_time (String) End time of the job.
id (Number) ID of the job created on OME appliance for carrying out the action.
last_run_status (String) Last run status of the job.
last_run_time (String) Last run time of the job.
next_run_time (String) Next run time of the job.
start_time (String) Start time of the job.

V1.2.3: ome_devices resource

Mon, 01 Jan 0001 00:00:00 +0000

ome_devices (Resource)

This terraform resource is used to manage a set of device entities on OME.

~> Note: Exactly one of ref_template_name and ref_template_id and exactly one of device_ids and device_servicetags are required.

~> Note: When schedule is true, following parameters are considered: notify_on_schedule, cron, email_addresses, output_format.

~> Note: Updates are supported for all the parameters.

Example Usage

/*
Copyright (c) 2024 Dell Inc., or its subsidiaries. All Rights Reserved.
Licensed under the Mozilla Public License Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
    http://mozilla.org/MPL/2.0/
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

# Resource to manage all devices
resource "ome_devices" "dev_list_1" {
}

# Resource to manage specific devices
resource "ome_devices" "dev_list_2" {
  devices = [
    {
      service_tag = "ABCD34"
    },
    {
      id = 2000
    },
    # removing this block will remove device with service tag `QWX321` from the OME
    {
      service_tag = "QWX321"
    }
  ]
}

After the execution of above resource block, devices would have been updated on the OME. For more information, Please check the terraform state file.

Schema

Optional

devices (Attributes List) List of devices to be managed by this resource. (see below for nested schema)

Read-Only

id (String) ID for devices resource.

Nested Schema for `devices`

Optional:

id (Number) ID of device.
service_tag (String) Service tag of device.

Read-Only:

management_ips (List of String) List of management IPs of device.

Import

Import is supported using the following syntax:

# /*
# Copyright (c) 2024 Dell Inc., or its subsidiaries. All Rights Reserved.
# Licensed under the Mozilla Public License Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#     http://mozilla.org/MPL/2.0/
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
# */

# import devices by their ids
terraform import ome_devices.device_list_ids_default "<id1>,<id2>,<id3>"

# another way to import devices by their ids
terraform import ome_devices.device_list_ids "id:<id1>,<id2>,<id3>"

# import devices by their service tags
terraform import ome_devices.device_list_svc_tags "svc_tag:<svc_tag_1>,<svc_tag_2>,<svc_tag_3>"

# import all available devices
terraform import ome_devices.device_list_all ""

V1.2.3: ome_discovery resource

Mon, 01 Jan 0001 00:00:00 +0000

ome_discovery (Resource)

This terraform resource is used to manage Discovery entity on OME.We can Create, Update and Delete OME Discoveries using this resource. We can also do an ‘Import’ an existing ‘Discovery’ from OME .

~> Note: Exactly one of ref_template_name and ref_template_id and exactly one of device_ids and device_servicetags are required.

~> Note: When schedule is true, following parameters are considered: notify_on_schedule, cron, email_addresses, output_format.

~> Note: Updates are supported for all the parameters.

Example Usage

resource "ome_discovery" "discover1" {
  name     = "discover-lab"
  schedule = "RunNow"
  # timeout to track the discovery job till x number of minutes.
  timeout = 10
  # ignore_partial_failure is used to control the terraform error in case of undiscovered ips after the discovery.
  ignore_partial_failure = true

  # discovery_config_targets is used to provide the server details
  discovery_config_targets = [
    {
      network_address_detail = ["10.0.0.0"]
      device_type            = ["SERVER"]
      wsman = {
        username = "user"
        password = "password"
      }
  }]
}

After the execution of above resource block, discovery would have been created on the OME. For more information, Please check the terraform state file.

Schema

Required

discovery_config_targets (Attributes Set) - Provide the list of discovery targets. - Each discovery target is a set of “network_address_detail”, “device_types”, and one or more protocol credentials. (see below for nested schema)
name (String) Name of the discovery configuration job
schedule (String) Provides the option to schedule the discovery job. If RunLater is selected, then attribute cron must be specified. If RunNow is selected, then attribute timeout must be specified.

Optional

cron (String) Provide a cron expression based on Quartz cron format
email_recipient (String) - Enter the email address to which notifications are to be sent about the discovery job status. - Configure the SMTP settings to allow sending notifications to an email address.
enable_community_strings (Boolean) - Enable the use of SNMP community strings to receive SNMP traps using Application Settings in OpenManage Enterprise. - This option is available only for the discovered iDRAC servers and MX7000 chassis.
ignore_partial_failure (Boolean) Provides the option to ignore partial failures. Partial failures occur when there is a combination of both discovered and undiscovered IPs with Schedule is set to RunNow. If partial_failure is set false then partial_failure is not ignored, and module will error out.If partial_failure is set true then partial_failure is ignored, and module will not error out.
timeout (Number) Provide a timeout in minute to track the job
trap_destination (Boolean) - Enable OpenManage Enterprise to receive the incoming SNMP traps from the discovered devices. - This is effective only for servers discovered by using their iDRAC interface.

Read-Only

id (String) ID of the discovery configuration group
job_id (Number) Discovery Job ID.
job_tracking (Attributes) Discovery Job Tracking Info Captured When Schedule is set to RunNow (see below for nested schema)

Nested Schema for `discovery_config_targets`

Required:

device_type (List of String) - Provide the type of devices to be discovered. - The accepted types are SERVER, CHASSIS, NETWORK SWITCH, and STORAGE. - A combination or all of the above can be provided. - “Supported protocols for each device type are:” - SERVER - “redfish”, “snmp”, and “ssh”. - CHASSIS - “redfish”. - NETWORK SWITCH - “snmp”. - STORAGE - “snmp”.
network_address_detail (List of String) - “Provide the list of IP addresses, host names, or the range of IP addresses of the devices to be discoveredor included.” - “Sample Valid IP Range Formats” - " 192.35.0.0" - " 192.36.0.0-10.36.0.255" - " 192.37.0.0/24" - " 2345:f2b1:f083:135::5500/118" - " 2345:f2b1:f083:135::a500-2607:f2b1:f083:135::a600" - " hostname.domain.tld" - " hostname" - " 2345:f2b1:f083:139::22a" - “Sample Invalid IP Range Formats” - " 192.35.0.*" - " 192.36.0.0-255" - " 192.35.0.0/255.255.255.0" - NOTE: The range size for the number of IP addresses is limited to 16,385 (0x4001). - NOTE: Both IPv6 and IPv6 CIDR formats are supported.

Optional:

redfish (Attributes) REDFISH protocol (see below for nested schema)
snmp (Attributes) Simple Network Management Protocol (SNMP) (see below for nested schema)
ssh (Attributes) Secure Shell (SSH) (see below for nested schema)
wsman (Attributes) WSMAN protocol (see below for nested schema)

Nested Schema for `discovery_config_targets.redfish`

Required:

password (String) Provide a password for the protocol.
username (String) Provide a username for the protocol.

Optional:

ca_check (Boolean) Enable the Certificate Authority (CA) check.
cn_check (Boolean) Enable the Common Name (CN) check.
port (Number) Enter the port number that the job must use to discover the devices.
retries (Number) Enter the number of repeated attempts required to discover a device
timeout (Number) Enter the time in seconds after which a job must stop running.

Nested Schema for `discovery_config_targets.snmp`

Required:

community (String) Community string for the SNMP protocol.

Optional:

port (Number) Enter the port number that the job must use to discover the devices.
retries (Number) Enter the number of repeated attempts required to discover a device.
timeout (Number) Enter the time in seconds after which a job must stop running.

Nested Schema for `discovery_config_targets.ssh`

Required:

password (String) Provide a password for the protocol.
username (String) Provide a username for the protocol.

Optional:

check_known_hosts (Boolean) Verify the known host key.
is_sudo_user (Boolean) Use the SUDO option
port (Number) Enter the port number that the job must use to discover the devices.
retries (Number) Enter the number of repeated attempts required to discover a device.
timeout (Number) Enter the time in seconds after which a job must stop running.

Nested Schema for `discovery_config_targets.wsman`

Required:

password (String) Provide a password for the protocol.
username (String) Provide a username for the protocol.

Optional:

ca_check (Boolean) Enable the Certificate Authority (CA) check.
cn_check (Boolean) Enable the Common Name (CN) check.
port (Number) Enter the port number that the job must use to discover the devices.
retries (Number) Enter the number of repeated attempts required to discover a device
timeout (Number) Enter the time in seconds after which a job must stop running.

Nested Schema for `job_tracking`

Read-Only:

discovered_ip (List of String) IPs discovered after tracking the job until it timeout.
job_execution_results (List of String) Provides information about job executions discovered after tracking the job until it timeout.
undiscovered_ip (List of String) IPs remains undiscovered after tracking the job until it timeout.

Import

Import is supported using the following syntax:

terraform import ome_discovery.code_1 "<discovery-job-id>"

V1.2.3: ome_firmware_baseline resource

Mon, 01 Jan 0001 00:00:00 +0000

ome_firmware_baseline (Resource)

This terraform resource is used to manage firmware baseline entity on OME.We can Create, Update and Delete OME firmware baseline using this resource. We can also do an ‘Import’ an existing ‘firmware baseline’ from OME .

Example Usage

/*
Copyright (c) 2024 Dell Inc., or its subsidiaries. All Rights Reserved.
Licensed under the Mozilla Public License Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
    http://mozilla.org/MPL/2.0/
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

# Resource to manage a new firmware baseline
resource "ome_firmware_baseline" "firmware_baseline" {
  // Required Fields
  # Name of the catalog
  catalog_name = "tfacc_catalog_dell_online_1"
  # Name of the Baseline
  name = "baselinetest"
  
  // Only one of the following fields (device_names, group_names , device_service_tags) is required
  # List of the Device names to associate with the firmware baseline.
  device_names = ["10.2.2.1"]
  
  # List of the Group names to associate with the firmware baseline.
  # group_names = ["HCI Appliances","Hyper-V Servers"]
  
  # List of the Device service tags to associate with the firmware baseline.
  # device_service_tags = ["HRPB0M3"]
  
  // Optional Fields
  // This must always be set to true. The size of the DUP files used is 64 bits."
  #is_64_bit = true

  // Filters applicable updates where no reboot is required during create baseline for firmware updates. This field is set to false by default.
  #filter_no_reboot_required = true
  
  # Description of the firmware baseline 
  description = "test baseline"
}

Schema

Required

catalog_name (String) Name of the catalog
name (String) Name of the firmware baseline

Optional

description (String) Description of the firmware baseline
device_names (List of String) Device names is the list of device names that you want to add to the firmware baseline being created. One of DeviceNames or DeviceServiceTags or GroupNames is required
device_service_tags (List of String) Device service tags is the list of device service tags that you want to add to the firmware baseline being created.One of DeviceNames or DeviceServiceTags or GroupNames is required
filter_no_reboot_required (Boolean) Filters applicable updates where no reboot is required during create baseline for firmware updates.
group_names (List of String) Group names is the list of group names that you want to add to the firmware baseline being created.One of DeviceNames or DeviceServiceTags or GroupNames is required
id (Number) ID of the firmware baseline.
is_64_bit (Boolean) This must always be set to true. The size of the DUP files used is 64 bits.
last_run (String) Last Run Time for the firmware baseline
repository_name (String) Name of the repository

Read-Only

catalog_id (Number) ID of the catalog.
compliance_summary (Object) Compliance Summary (see below for nested schema)
downgrade_enabled (Boolean) Indicates if the firmware can be downgraded
repository_id (Number) ID of the repository. Derived from the catalog response
repository_type (String) Type of the repository
targets (Attributes List) The DeviceID, if the baseline is being created for devices or, the GroupID, if the baseline is being created for a group of devices. (see below for nested schema)
task_id (Number) Identifier of task which created this baseline.
task_status (String) Task status.

Nested Schema for `compliance_summary`

Read-Only:

compliance_status (String)
number_of_critical (Number)
number_of_downgrade (Number)
number_of_normal (Number)
number_of_unknown (Number)
number_of_warning (Number)

Nested Schema for `targets`

Required:

id (Number) ID of device associated with the firmware baseline.
type (Object) Type of device associated with the firmware baseline.. (see below for nested schema)

Nested Schema for `targets.type`

Read-Only:

id (Number)
name (String)

Import

Import is supported using the following syntax:

# Copyright (c) 2024 Dell Inc., or its subsidiaries. All Rights Reserved.

# Licensed under the Mozilla Public License Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at

#     http://mozilla.org/MPL/2.0/


# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

# The command is
# terraform import ome_firmware_baseline.baseline <id>
# Example:
terraform import ome_firmware_baseline.baseline 6
# after running this command, populate the name field in the config file to start managing this resource

V1.2.3: ome_firmware_catalog resource

Mon, 01 Jan 0001 00:00:00 +0000

ome_firmware_catalog (Resource)

This terraform resource is used to manage firmware catalogs entity on OME.We can Create, Update and Delete OME firmware catalogs using this resource. We can also do an ‘Import’ an existing ‘firmware catalog’ from OME .

Example Usage

/*
Copyright (c) 2024 Dell Inc., or its subsidiaries. All Rights Reserved.
Licensed under the Mozilla Public License Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
    http://mozilla.org/MPL/2.0/
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

# Resource to manage a new firmware catalog
resource "ome_firmware_catalog" "firmware_catalog_example" {
  # Name of the catalog required
  name = "example_catalog_1"
  
  # Catalog Update Type required.
  # Sets to Manual or Automatic on schedule catalog updates of the catalog. 
  # Defaults to manual.
  catalog_update_type = "Automatic"
  
  # Share type required.
  # Sets the different types of shares (DELL_ONLINE, NFS, CIFS, HTTP, HTTPS)
  # Defaults to DELL_ONLINE
  share_type = "HTTPS"

  # Catalog file path, required for share types (NFS, CIFS, HTTP, HTTPS)
  # Start directory path without leading '/' and use alphanumeric characters. 
  catalog_file_path = "catalogs/example_catalog_1.xml"

  # Share Address required for share types (NFS, CIFS, HTTP, HTTPS)
  # Must be a valid ipv4 (x.x.x.x), ipv6(xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx), or fqdn(example.com)
  # And include the protocol prefix ie (https://)
  share_address = "https://1.2.2.1"
 
  # Catalog refresh schedule, Required for catalog_update_type Automatic.
  # Sets the frequency of the catalog refresh.
  # Will be ignored if catalog_update_type is set to manual.
  catalog_refresh_schedule = {
    # Sets to (Weekly or Daily)
    cadence = "Weekly"
    # Sets the day of the week (Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday)
    day_of_the_week = "Wednesday"
    # Sets the hour of the day (1-12)
    time_of_day = "6"
    # Sets (AM or PM)
    am_pm = "PM"
  }
  
  # Domain optional value for the share (CIFS), for other share types this will be ignored
  domain = "example"

  # Share user required value for the share (CIFS), optional value for the share (HTTPS)
  share_user = "example-user"

  # Share password required value for the share (CIFS), optional value for the share (HTTPS)
  share_password = "example-pass"
}

Schema

Required

name (String) Name of the new catalog.

Optional

catalog_file_path (String) Catalog File Path. Path on the share to gather catalog data. This field is required for share_types (NFS, CIFS, HTTP, HTTPS)
catalog_refresh_schedule (Attributes) Catalog Refresh Schedule, when using automatic catalog update the schedule is required for cadence of the update. If catalog_update_type is set to manual, this field is ignored. (see below for nested schema)
catalog_update_type (String) Catalog Update Type. Sets the frequency of catalog updates. Defaults to Manual. If set to automatic, the catalog_refresh_schedule field will need to be set. Options are (Manual, Automatic).
domain (String) Domain. The domain for the catalog. This field is optional and only used for share_types (CIFS).
share_address (String) Share Address. Gives the Ipv4, Ipv6, or FQDN of the share. This field is required for share_types (NFS, CIFS, HTTP, HTTPS)
share_password (String, Sensitive) Share Password. The password related to the share address. This field is required for share_types (CIFS, HTTPS)
share_type (String) Share Type, the type of share the catalog will pull from, Defaults to Dell. The different options will have different required fields to work properly. Options are (DELL, NFS, CIFS, HTTP, HTTPS).
share_user (String) Share User. The username related to the share address. This field is required for share_types (CIFS, HTTPS).

Read-Only

associated_baselines (Attributes List) Associated Baselines. (see below for nested schema)
baseline_location (String) Baseline Location.
bundles_count (Number) Bundles Count.
create_date (String) Create Date.
filename (String) Filename.
id (Number) id.
last_update (String) Last Update.
manifest_identifier (String) Manifest Identifier.
manifest_version (String) Manifest Version.
next_update (String) Next Update.
owner_id (Number) Owner ID.
predcessor_identifier (String) Predcessor Identifier.
release_identifier (String) Release Identifier.
repository (Object) Repository. (see below for nested schema)
source_path (String) Source path.
status (String) Status.
task_id (Number) Task ID.

Nested Schema for `catalog_refresh_schedule`

Optional:

am_pm (String) AM/PM for the schedule. Options are (AM, PM).
cadence (String) Cadence. Options are(Weekly, Daily).
day_of_the_week (String) Day of the Week, only useful for weekly schedules. Options are(Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday).
time_of_day (Number) Time of Day for the schedule in hour increments. Options are (1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12).

Nested Schema for `associated_baselines`

Read-Only:

baseline_id (Number) Baseline ID.
baseline_name (String) Baseline Name.

Nested Schema for `repository`

Read-Only:

backup_existing_catalog (Boolean)
check_certificate (Boolean)
description (String)
domain_name (String)
editable (Boolean)
id (Number)
name (String)
repository_type (String)
source (String)
username (String)

Import

Import is supported using the following syntax:

# Copyright (c) 2024 Dell Inc., or its subsidiaries. All Rights Reserved.

# Licensed under the Mozilla Public License Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at

#     http://mozilla.org/MPL/2.0/


# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

# The command is
# terraform import ome_firmware_catalog.cat_1 <id>
# Example:
terraform import ome_firmware_catalog.cat_1 1
# after running this command, populate the name field in the config file to start managing this resource

V1.2.3: ome_static_group resource

Mon, 01 Jan 0001 00:00:00 +0000

ome_static_group (Resource)

This terraform resource is used to manage Static Device Group entity on OME.We can Create, Update and Delete OME Static Device Group using this resource. We can also do an ‘Import’ an existing ‘Static Device Group’ from OME .

~> Note: Exactly one of ref_template_name and ref_template_id and exactly one of device_ids and device_servicetags are required.

~> Note: When schedule is true, following parameters are considered: notify_on_schedule, cron, email_addresses, output_format.

~> Note: Updates are supported for all the parameters.

Example Usage

# /*
# Copyright (c) 2024 Dell Inc., or its subsidiaries. All Rights Reserved.
# Licensed under the Mozilla Public License Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#     http://mozilla.org/MPL/2.0/
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
# */

# get all devices in the CIDR "10.10.10.10/26" with model PowerEdge MX840c
data "ome_device" "devs" {
  filters = {
    ip_expressions    = ["10.10.10.10/26"]
    filter_expression = "Model eq 'PowerEdge MX840c'"
  }
}

# get the root group of all static groups in OME
# we are mainly concerned with the ID of this group which we shall use to create a child group
data "ome_groupdevices_info" "ome_root" {
  device_group_names = ["Static Groups"]
}

# Create a group of all the devices fetched by the device datasource
# Its parent group will be "Static Groups"
resource "ome_static_group" "pE-slash-26" {
  name        = "Group46"
  description = "Group of all devices in the CIDR '10.10.10.10/26' with model PowerEdge MX840c"
  parent_id   = data.ome_groupdevices_info.ome_root.device_groups["Static Groups"].id
  device_ids  = data.ome_device.devs.devices[*].id
}

After the execution of above resource block, static group would have been created on the OME. For more information, Please check the terraform state file.

Schema

Required

name (String) Name of the static group.
parent_id (Number) ID of the parent group of the static group. If the value of parent_id changes, Terraform will destroy and recreate the resource.

Optional

description (String) Description of the static group.
device_ids (Set of Number) List of IDs of child devices of the group.

Read-Only

id (Number) ID of the static group.
membership_type_id (Number) Membership type of the static group.

Import

Import is supported using the following syntax:

# /*
# Copyright (c) 2024 Dell Inc., or its subsidiaries. All Rights Reserved.
# Licensed under the Mozilla Public License Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#     http://mozilla.org/MPL/2.0/
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
# */

terraform import ome_static_group.group_1 "<existing_static_group_name>"

V1.2.3: ome_template resource

Mon, 01 Jan 0001 00:00:00 +0000

ome_template (Resource)

This terraform resource is used to manage Template entity on OME.We can Create, Update and Delete OME Template using this resource. We can also do an ‘Import’ an existing ‘Template’ from OME.

~> Note: Exactly one of reftemplate_name, refdevice_id, refdevice_servicetag and content are required.

Example Usage

/*
Copyright (c) 2024 Dell Inc., or its subsidiaries. All Rights Reserved.
Licensed under the Mozilla Public License Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
    http://mozilla.org/MPL/2.0/
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

# create a template with reference device id.
resource "ome_template" "template_1" {
  name         = "template_1"
  refdevice_id = 10001
}

# create a template with reference device servicetag.
resource "ome_template" "template_2" {
  name                 = "template_2"
  refdevice_servicetag = "MXL1234"
}

# create a template with fqdds as NIC.
resource "ome_template" "template_3" {
  name         = "template_3"
  refdevice_id = 10001
  fqdds        = "NIC"
}

# used to fetch vlan network data
data "ome_vlannetworks_info" "vlans" {
}


data "ome_template_info" "template_data" {
  name = "template_4"
}

#use locals to fetch vlan network ID from vlan name for updating vlan template attributes.
locals {
  vlan_network_map = { for vlan_network in data.ome_vlannetworks_info.vlans.vlan_networks : vlan_network.name => vlan_network.vlan_id }
}

#use locals to modify the attributes required for updating a template for assigning identity pool.
locals {
  attributes_value = tomap({
    "iDRAC,IO Identity Optimization,IOIDOpt 1 Initiator Persistence Policy" : "WarmReset, ColdReset, ACPowerLoss"
    "iDRAC,IO Identity Optimization,IOIDOpt 1 Storage Target Persistence Policy" : "WarmReset, ColdReset, ACPowerLoss"
    "iDRAC,IO Identity Optimization,IOIDOpt 1 Virtual Address Persistence Policy Auxiliary Powered" : "WarmReset, ColdReset, ACPowerLoss"
    "iDRAC,IO Identity Optimization,IOIDOpt 1 Virtual Address Persistence Policy Non Auxiliary Powered" : "WarmReset, ColdReset, ACPowerLoss"
    "iDRAC,IO Identity Optimization,IOIDOpt 1 IOIDOpt Enable" : "Enabled"

  })
  attributes_is_ignored = tomap({
    "iDRAC,IO Identity Optimization,IOIDOpt 1 Initiator Persistence Policy" : false
    "iDRAC,IO Identity Optimization,IOIDOpt 1 Storage Target Persistence Policy" : false
    "iDRAC,IO Identity Optimization,IOIDOpt 1 Virtual Address Persistence Policy Auxiliary Powered" : false
    "iDRAC,IO Identity Optimization,IOIDOpt 1 Virtual Address Persistence Policy Non Auxiliary Powered" : false
    "iDRAC,IO Identity Optimization,IOIDOpt 1 IOIDOpt Enable" : false

  })

  template_attributes = data.ome_template_info.template_data.attributes != null ? [
    for attr in data.ome_template_info.template_data.attributes : tomap({
      attribute_id = attr.attribute_id
      is_ignored   = lookup(local.attributes_is_ignored, attr.display_name, attr.is_ignored)
      display_name = attr.display_name
      value        = lookup(local.attributes_value, attr.display_name, attr.value)
  })] : null
}

# create a template and uncomment the below in a resouce to update the template to attach the identity pool and vlan.
# identity pool and vlan attributes are applicable as part of the update operation, please uncomment it to update after the create is finished.
resource "ome_template" "template_4" {
  name                 = "template_4"
  refdevice_servicetag = "MXL1234"
  # attributes = local.template_attributes
  # identity_pool_name   = "IO1"
  # vlan = {
  #     propogate_vlan     = true
  #     bonding_technology = "NoTeaming"
  #     vlan_attributes = [
  #       {
  #         untagged_network = lookup(local.vlan_network_map, "VLAN1", 0)
  #         tagged_networks  = [0]
  #         is_nic_bonded    = false
  #         port             = 1
  #         nic_identifier   = "NIC in Mezzanine 1A"
  #       },
  #       {
  #         untagged_network = 0
  #         tagged_networks  = [lookup(local.vlan_network_map, "VLAN1", 0), lookup(local.vlan_network_map, "VLAN2", 0), lookup(local.vlan_network_map, "VLAN3", 0)]
  #         is_nic_bonded    = false
  #         port             = 1
  #         nic_identifier   = "NIC in Mezzanine 1B"
  #       },
  #     ]
  #   }
}


# get the template details 
data "ome_template_info" "template_data1" {
  name = "template_5"
}


#use locals to modify the attributes required for updating a template using attribute ids.
locals {
  attributes_map = tomap({
    2740260 : "One Way"
    2743100 : "Disabled"
  })

  template_attributes = data.ome_template_info.template_data1.attributes != null ? [
    for attr in data.ome_template_info.template_data1.attributes : tomap({
      attribute_id = attr.attribute_id
      is_ignored   = attr.is_ignored
      display_name = attr.display_name
      value        = lookup(local.attributes_map, attr.attribute_id, attr.value)
  })] : null
}

#use locals to modify the attributes required for updating a template using display name.
locals {
  attributes_map = tomap({
    "iDRAC,Time Zone Configuration Information,Time 1 Time Zone String" : "IST"
    "System,Server Topology,ServerTopology 1 Aisle Name" : "Aisle-123"
    "iDRAC,User Domain,UserDomain 1 User Domain Name" : "TestDomain1"
  })

  template_attributes = data.ome_template_info.template_data1.attributes != null ? [
    for attr in data.ome_template_info.template_data1.attributes : tomap({
      attribute_id = attr.attribute_id
      is_ignored   = attr.is_ignored
      display_name = attr.display_name
      value        = lookup(local.attributes_map, attr.display_name, attr.value)
  })] : null
}

# create a template and update the attributes of the template
# attributes are only updatable and is not applicable during create operation.
# attributes existing list can be fetched from a template with a datasource - ome_template_info as defined above.
# modified attributes list should be passed to update the attributes for a template
resource "ome_template" "template_5" {
  name                 = "template_5"
  refdevice_servicetag = "MXL1234"
  attributes           = local.template_attributes
}


# create multiple templates with template names and reference devices.
resource "ome_template" "templates" {
  count                = length(var.ome_template_names)
  name                 = var.ome_template_names[count.index]
  refdevice_servicetag = var.ome_template_servicetags[count.index]
}

# Clone a deploy template to create compliance template.
resource "ome_template" "template_6" {
  name             = "template_6"
  reftemplate_name = "template_5"
  view_type        = "Compliance"
}

# Create a deployment template from a XML.
resource "ome_template" "template_7" {
  name    = "template_7"
  content = file("../testdata/test_acc_template.xml")
}

# Create a compliance template from a XML.
resource "ome_template" "template_8" {
  name      = "template_8"
  content   = file("../testdata/test_acc_template.xml")
  view_type = "Compliance"
}

After the execution of above resource block, template would have been created on the OME. For more information, Please check the terraform state file.

Schema

Required

name (String) Name of the template resource.

Optional

attributes (List of Object) List of attributes associated with a template. This field is ignored while creating a template. (see below for nested schema)
content (String) The XML content of template. Cannot be updated.
description (String) Description of the template
device_type (String) OME template device type, supported types are Server, Chassis. Cannot be updated and is applicable only for importing xml. Valid values are Server and Chassis. Default value is Server.
fqdds (String) Comma seperated values of components from a specified server. Valid values are iDRAC, System, BIOS, NIC, LifeCycleController, RAID, EventFilters and All. Default value is All. Cannot be updated.
identity_pool_name (String) Identity Pool name to be attached with template.
job_retry_count (Number) Number of times the job has to be polled to get the final status of the resource. Default value is 5.
refdevice_id (Number) Target device id from which the template needs to be created. Cannot be updated.
refdevice_servicetag (String) Target device servicetag from which the template needs to be created. Cannot be updated.
reftemplate_name (String) Reference Template name from which the template needs to be cloned. Cannot be updated.
sleep_interval (Number) Sleep time interval for job polling in seconds. Default value is 30.
view_type (String) OME template view type. Valid values are Deployment and Compliance. Default value is Deployment. Cannot be updated.
vlan (Object) VLAN details to be attached with template. (see below for nested schema)

Read-Only

id (String) ID of the template resource.
identity_pool_id (Number) ID of the Identity Pool attached with template.
view_type_id (Number) OME template view type id.

Nested Schema for `attributes`

Optional:

attribute_id (Number)
display_name (String)
is_ignored (Boolean)
value (String)

Nested Schema for `vlan`

Optional:

bonding_technology (String)
propogate_vlan (Boolean)
vlan_attributes (List of Object) (see below for nested schema)

Nested Schema for `vlan.vlan_attributes`

Optional:

is_nic_bonded (Boolean)
nic_identifier (String)
port (Number)
tagged_networks (Set of Number)
untagged_network (Number)

Import

Import is supported using the following syntax:

# /*
# Copyright (c) 2024 Dell Inc., or its subsidiaries. All Rights Reserved.
# Licensed under the Mozilla Public License Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#     http://mozilla.org/MPL/2.0/
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
# */

terraform import ome_template.citctest "<existing_template_name>"

V1.2.3: ome_user resource

Mon, 01 Jan 0001 00:00:00 +0000

ome_user (Resource)

This terraform resource is used to manage User entity on OME.We can Create, Update and Delete OME User using this resource. We can also do an ‘Import’ an existing ‘User’ from OME.

~> Note: Exactly one of ref_template_name and ref_template_id and exactly one of device_ids and device_servicetags are required.

~> Note: When schedule is true, following parameters are considered: notify_on_schedule, cron, email_addresses, output_format.

~> Note: Updates are supported for all the parameters.

Example Usage

resource "ome_user" "code_1" {
  # required params
  username = "Dell"
  password = "Dell123!"
  role_id  = "10"
  # optional params
  user_type_id         = 1
  directory_service_id = 0
  description          = "Avengers alpha"
  locked               = false
  enabled              = false
}

After the execution of above resource block, user would have been created on the OME. For more information, Please check the terraform state file.

Schema

Required

password (String, Sensitive) Password of the OME user.
role_id (String) Role ID of the OME user.
username (String) Username of the OME user.

Optional

description (String) Description of the OME user.
directory_service_id (Number) Directory Service ID of the OME user. If the value of directory_service_id changes, Terraform will destroy and recreate the resource.
enabled (Boolean) Enable OME user.
locked (Boolean) Lock OME user. If the value of locked changes, Terraform will destroy and recreate the resource.
user_type_id (Number) User Type ID of the OME user. If the value of user_type_id changes, Terraform will destroy and recreate the resource.

Read-Only

id (String) ID of the OME user.

Import

Import is supported using the following syntax:

terraform import ome_user.code_3 "<user-id>,<user-password>"

Dell Technologies – Resources

V1.2.3: ome_appliance_network resource

ome_appliance_network (Resource)

Example Usage

Schema

Optional

Read-Only

Nested Schema for adapter_setting

Nested Schema for adapter_setting.dns_configuration

Nested Schema for adapter_setting.ipv4_configuration

Nested Schema for adapter_setting.ipv6_configuration

Nested Schema for adapter_setting.management_vlan

Nested Schema for proxy_setting

Nested Schema for session_setting

Nested Schema for time_setting

V1.2.3: ome_application_certificate resource

ome_application_certificate (Resource)

Example Usage

Schema

Required

Read-Only

V1.2.3: ome_application_csr resource

ome_application_csr (Resource)

Example Usage

Schema

Required

Read-Only

Nested Schema for specs

V1.2.3: ome_configuration_baseline resource

ome_configuration_baseline (Resource)

Example Usage

Schema

Required

Optional

Read-Only

Import

V1.2.3: ome_configuration_compliance resource

ome_configuration_compliance (Resource)

Example Usage

Schema

Required

Optional

Read-Only

Nested Schema for target_devices

V1.2.3: ome_deployment resource

ome_deployment (Resource)

Example Usage

Schema

Optional

Read-Only

Nested Schema for boot_to_network_iso

Nested Schema for boot_to_network_iso.share_detail

Nested Schema for device_attributes

Nested Schema for device_attributes.attributes

Import

V1.2.3: ome_device_action resource

ome_device_action (Resource)

Example Usage

Schema

Required

Optional

Read-Only

V1.2.3: ome_devices resource

ome_devices (Resource)

Example Usage

Schema

Optional

Read-Only

Nested Schema for devices

Import

V1.2.3: ome_discovery resource

ome_discovery (Resource)

Example Usage

Schema

Required

Optional

Read-Only

Nested Schema for discovery_config_targets

Nested Schema for discovery_config_targets.redfish

Nested Schema for discovery_config_targets.snmp

Nested Schema for `adapter_setting`

Nested Schema for `adapter_setting.dns_configuration`

Nested Schema for `adapter_setting.ipv4_configuration`

Nested Schema for `adapter_setting.ipv6_configuration`

Nested Schema for `adapter_setting.management_vlan`

Nested Schema for `proxy_setting`

Nested Schema for `session_setting`

Nested Schema for `time_setting`

Nested Schema for `specs`

Nested Schema for `target_devices`

Nested Schema for `boot_to_network_iso`

Nested Schema for `boot_to_network_iso.share_detail`

Nested Schema for `device_attributes`

Nested Schema for `device_attributes.attributes`

Nested Schema for `devices`

Nested Schema for `discovery_config_targets`

Nested Schema for `discovery_config_targets.redfish`

Nested Schema for `discovery_config_targets.snmp`

Nested Schema for `discovery_config_targets.ssh`

Nested Schema for `discovery_config_targets.wsman`

Nested Schema for `job_tracking`

Nested Schema for `compliance_summary`

Nested Schema for `targets`

Nested Schema for `targets.type`

Nested Schema for `catalog_refresh_schedule`

Nested Schema for `associated_baselines`

Nested Schema for `repository`

Nested Schema for `attributes`

Nested Schema for `vlan`

Nested Schema for `vlan.vlan_attributes`