dellemc.openmanage.ome_device_quick_deploy module – Configure Quick Deploy settings on OpenManage Enterprise Modular.
Note
This module is part of the dellemc.openmanage collection (version 9.8.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.ome_device_quick_deploy.
New in dellemc.openmanage 5.0.0
Synopsis
This module allows to configure the Quick Deploy settings of the server or IOM on OpenManage Enterprise Modular.
Requirements
The below requirements are needed on the host that executes this module.
python >= 3.9.6
Parameters
Parameter |
Comments |
|---|---|
The Privacy Enhanced Mail (PEM) file that contains a CA certificate to be used for the validation. |
|
The ID of the chassis for which the Quick Deploy settings to be deployed. If the device ID is not specified, this module updates the Quick Deploy settings for the hostname. device_id is mutually exclusive with device_service_tag. |
|
The service tag of the chassis for which the Quick Deploy settings to be deployed. If the device service tag is not specified, this module updates the Quick Deploy settings for the hostname. device_service_tag is mutually exclusive with device_id. |
|
OpenManage Enterprise Modular IP address or hostname. |
|
Determines whether to wait for the job completion or not. Choices:
|
|
The maximum wait time of job_wait in seconds. The job is tracked only for this duration. This option is applicable when job_wait is Default: |
|
OpenManage Enterprise Modular password. If the password is not provided, then the environment variable Example: export OME_PASSWORD=password |
|
OpenManage Enterprise Modular HTTPS port. Default: |
|
The Quick Deploy settings for server and IOM quick deploy. |
|
Enables or disables the IPv4 network. Choices:
|
|
IPv4 gateway. ipv4_gateway is required if ipv4_network_type is |
|
IPv4 network type. ipv4_network_type is required if ipv4_enabled is
Choices:
|
|
IPv4 subnet mask. ipv4_subnet_mask is required if ipv4_network_type is |
|
Enables or disables the IPv6 network. Choices:
|
|
IPv6 gateway. ipv6_gateway is required if ipv6_network_type is |
|
IPv6 network type. ipv6_network_type is required if ipv6_enabled is
Choices:
|
|
IPV6 prefix length. ipv6_prefix_length is required if ipv6_network_type is |
|
The password to login to the server or IOM. The module will always report change when password option is added. |
|
The slot configuration for the server or IOM. |
|
The ID of the slot. |
|
The IPv4 address of the slot. |
|
The IPv6 address of the slot. |
|
The ID of the VLAN. |
|
The type of the Quick Deploy settings to be applied.
Choices:
|
|
The socket level timeout in seconds. Default: |
|
OpenManage Enterprise Modular username. If the username is not provided, then the environment variable Example: export OME_USERNAME=username |
|
If Configure Prior to collection version Choices:
|
|
Authentication token. If the x_auth_token is not provided, then the environment variable Example: export OME_X_AUTH_TOKEN=x_auth_token |
Notes
Note
Run this module from a system that has direct access to OpenManage Enterprise Modular.
This module supports
check_mode.The module will always report change when password option is added.
If the chassis is a member of a multi-chassis group and it is assigned as a backup lead chassis, the operations performed on the chassis using this module may conflict with the management operations performed on the chassis through the lead chassis.
Examples
---
- name: Configure server Quick Deploy settings of the chassis using device ID.
dellemc.openmanage.ome_device_quick_deploy:
hostname: "192.168.0.1"
username: "username"
password: "password"
device_id: 25011
setting_type: ServerQuickDeploy
ca_path: "/path/to/ca_cert.pem"
quick_deploy_options:
password: "password"
ipv4_enabled: true
ipv4_network_type: Static
ipv4_subnet_mask: 255.255.255.0
ipv4_gateway: 192.168.0.1
ipv6_enabled: true
ipv6_network_type: Static
ipv6_prefix_length: 1
ipv6_gateway: "::"
slots:
- slot_id: 1
slot_ipv4_address: 192.168.0.2
slot_ipv6_address: "::"
vlan_id: 1
- slot_id: 2
slot_ipv4_address: 192.168.0.3
slot_ipv6_address: "::"
vlan_id: 2
- name: Configure server Quick Deploy settings of the chassis using device service tag.
dellemc.openmanage.ome_device_quick_deploy:
hostname: "192.168.0.1"
username: "username"
password: "password"
device_service_tag: GHRT2RL
setting_type: IOMQuickDeploy
ca_path: "/path/to/ca_cert.pem"
quick_deploy_options:
password: "password"
ipv4_enabled: true
ipv4_network_type: Static
ipv4_subnet_mask: 255.255.255.0
ipv4_gateway: 192.168.0.1
ipv6_enabled: true
ipv6_network_type: Static
ipv6_prefix_length: 1
ipv6_gateway: "::"
slots:
- slot_id: 1
slot_ipv4_address: 192.168.0.2
slot_ipv6_address: "::"
vlan_id: 1
- slot_id: 2
slot_ipv4_address: 192.168.0.3
slot_ipv6_address: "::"
vlan_id: 2
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
Details of the HTTP Error. Returned: on HTTP error Sample: |
|
The job ID of the submitted quick deploy job. Returned: when quick deploy job is submitted. Sample: |
|
Overall status of the device quick deploy settings. Returned: always Sample: |
|
returned when quick deploy settings are deployed successfully. Returned: success Sample: |