dellemc.openmanage.omevv_baseline_profile module – Create, modify, or delete baseline profile

Note

This module is part of the dellemc.openmanage collection (version 9.9.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install dellemc.openmanage. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: dellemc.openmanage.omevv_baseline_profile.

New in dellemc.openmanage 9.9.0

Synopsis

  • This module allows you to create, modify, or delete an OpenManage Enterprise Integration for VMware Center (OMEVV) baseline profile.

Requirements

The below requirements are needed on the host that executes this module.

  • python >= 3.9.6

Parameters

Parameter

Comments

ca_path

path

The Privacy Enhanced Mail (PEM) file that contains a CA certificate to be used for the validation.

cluster

list / elements=string

List of cluster(s) for baseline profile creation.

This parameter is required when state is present and while creating a new profile.

days

list / elements=string

Required days of a week on when the job must run.

This is required when state is present and while creating a new profile.

Choices:

  • "sunday"

  • "monday"

  • "tuesday"

  • "wednesday"

  • "thursday"

  • "friday"

  • "saturday"

  • "all"

description

string

Description of the baseline profile.

hostname

string / required

IP address or hostname of the OpenManage Enterprise Modular.

job_wait

boolean

Whether to wait till completion of the job.

Choices:

  • false

  • true ← (default)

job_wait_timeout

integer

The maximum wait time of job_wait in seconds. The job is tracked only for this duration.

This is applicable when job_wait is true.

Default: 1200

name

string / required

Name of the baseline profile.

port

integer

OpenManage Enterprise HTTPS port.

Default: 443

repository_profile

string

Repository profile for baseline creation.

This is required when state is present and while creating a new profile.

state

string

present creates a baseline profile or modifies an existing profile if the profile with the same name already exists.

absent deletes the baseline profile.

repository_profile, cluster, days and time is required when creating a new baseline profile.

Either profile_name or profile_id is required when state is absent.

Choices:

  • "present" ← (default)

  • "absent"

time

string

Time at when the job must run, and is 24 hours format.

The format must be HH:MM.

This is required when state is present and while creating a new profile.

timeout

integer

The socket level timeout in seconds.

Default: 30

validate_certs

boolean

Whether to check SSL certificate. - If true, the SSL certificates will be validated. - If false, the SSL certificates will not be validated.

Choices:

  • false

  • true ← (default)

vcenter_password

string

Password for OpenManage Enterprise Integration for VMware vCenter (OMEVV).

If the password is not provided, then the environment variable OMEVV_VCENTER_PASSWORD is used.

Example: export OMEVV_VCENTER_PASSWORD=password

vcenter_username

string

Username for OpenManage Enterprise Integration for VMware vCenter (OMEVV).

If the username is not provided, then the environment variable OMEVV_VCENTER_USERNAME is used.

Example: export OMEVV_VCENTER_USERNAME=username

vcenter_uuid

string

Universally Unique Identifier (UUID) of vCenter.

vCenter UUID details can be retrieved using dellemc.openmanage.omevv_vcenter_info module.

If UUID is not provided, then the environment variable OMEVV_VCENTER_UUID is used.

Example: export OMEVV_VCENTER_UUID=uuid

Attributes

Attribute

Support

Description

check_mode

Support: full

Runs task to validate without performing action on the target machine.

diff_mode

Support: full

Runs the task to report the changes that are made or the changes that must be applied.

Notes

Note

  • Run this module from a system that has direct access to Dell OpenManage Enterprise.

Examples

---
- name: Create a baseline profile for multiple cluster
  dellemc.openmanage.omevv_baseline_profile:
    hostname: "192.168.0.1"
    vcenter_uuid: "xxxxx"
    vcenter_username: "username"
    vcenter_password: "password"
    ca_path: "path/to/ca_file"
    state: "present"
    name: "profile-1"
    repository_profile: "repository-profile"
    cluster:
      - "cluster-1"
      - "cluster-2"
    days:
      - "sunday"
      - "wednesday"
    time: "22:10"

- name: Modify a baseline profile
  dellemc.openmanage.omevv_baseline_profile:
    hostname: "192.168.0.1"
    vcenter_uuid: "xxxxx"
    vcenter_username: "username"
    vcenter_password: "password"
    ca_path: "path/to/ca_file"
    state: "present"
    name: "profile-1"
    new_name: "profile-newname"
    repository_profile: "repository-profile"
    cluster:
      - "cluster-1"
      - "cluster-2"
    days:
      - "sunday"
    time: "05:00"

- name: Delete a specific baseline profile
  dellemc.openmanage.omevv_baseline_profile:
    hostname: "192.168.0.1"
    vcenter_uuid: "xxxxx"
    vcenter_username: "username"
    vcenter_password: "password"
    ca_path: "path/to/ca_file"
    state: "absent"
    name: "profile-1"

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

error_info

dictionary

Details of the module HTTP Error.

Returned: on HTTP error

Sample: {"errorCode": "18001", "message": "Baseline profile with name Test already exists."}

msg

string

Status of the profile operation.

Returned: always

Sample: "Successfully created the OMEVV baseline profile."

Authors

  • Saksham Nautiyal (@Saksham-Nautiyal)