Try SpotterConfigure Quick Deploy settings on OpenManage Enterprise Modular.
| "added in version" 5.0.0 of dellemc.openmanage"
Authors: Felix Stephen (@felixs88), Shivam Sharma (@ShivamSh3), Kritika Bhateja (@Kritika-Bhateja-03)
Install with ansible-galaxy collection install dellemc.openmanage:==9.1.0
collections:
- name: dellemc.openmanage
version: 9.1.0This module allows to configure the Quick Deploy settings of the server or IOM on OpenManage Enterprise Modular.
---
- 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
port:
default: 443
description: OpenManage Enterprise Modular HTTPS port.
type: int
ca_path:
description:
- The Privacy Enhanced Mail (PEM) file that contains a CA certificate to be used for
the validation.
type: path
version_added: 5.0.0
version_added_collection: dellemc.openmanage
timeout:
default: 30
description: The socket level timeout in seconds.
type: int
version_added: 5.0.0
version_added_collection: dellemc.openmanage
hostname:
description: OpenManage Enterprise Modular IP address or hostname.
required: true
type: str
job_wait:
default: true
description: Determines whether to wait for the job completion or not.
type: bool
password:
description:
- OpenManage Enterprise Modular password.
- If the password is not provided, then the environment variable C(OME_PASSWORD) is
used.
- 'Example: export OME_PASSWORD=password'
required: true
type: str
username:
description:
- OpenManage Enterprise Modular username.
- If the username is not provided, then the environment variable C(OME_USERNAME) is
used.
- 'Example: export OME_USERNAME=username'
required: true
type: str
device_id:
description:
- 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 I(hostname).
- I(device_id) is mutually exclusive with I(device_service_tag).
type: int
setting_type:
choices:
- ServerQuickDeploy
- IOMQuickDeploy
description:
- The type of the Quick Deploy settings to be applied.
- C(ServerQuickDeploy) to apply the server Quick Deploy settings.
- C(IOMQuickDeploy) to apply the IOM Quick Deploy settings.
required: true
type: str
validate_certs:
default: true
description:
- If C(false), the SSL certificates will not be validated.
- Configure C(false) only on personally controlled sites where self-signed certificates
are used.
- Prior to collection version C(5.0.0), the I(validate_certs) is C(false) by default.
type: bool
version_added: 5.0.0
version_added_collection: dellemc.openmanage
job_wait_timeout:
default: 120
description:
- The maximum wait time of I(job_wait) in seconds. The job is tracked only for this
duration.
- This option is applicable when I(job_wait) is C(true).
type: int
device_service_tag:
description:
- 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 I(hostname).
- I(device_service_tag) is mutually exclusive with I(device_id).
type: str
quick_deploy_options:
description: The Quick Deploy settings for server and IOM quick deploy.
required: true
suboptions:
ipv4_enabled:
description: Enables or disables the IPv4 network.
type: bool
ipv4_gateway:
description:
- IPv4 gateway.
- I(ipv4_gateway) is required if I(ipv4_network_type) is C(Static).
type: str
ipv4_network_type:
choices:
- Static
- DHCP
description:
- IPv4 network type.
- I(ipv4_network_type) is required if I(ipv4_enabled) is C(true).
- C(Static) to configure the static IP settings.
- C(DHCP) to configure the Dynamic IP settings.
type: str
ipv4_subnet_mask:
description:
- IPv4 subnet mask.
- I(ipv4_subnet_mask) is required if I(ipv4_network_type) is C(Static).
type: str
ipv6_enabled:
description: Enables or disables the IPv6 network.
type: bool
ipv6_gateway:
description:
- IPv6 gateway.
- I(ipv6_gateway) is required if I(ipv6_network_type) is C(Static).
type: str
ipv6_network_type:
choices:
- Static
- DHCP
description:
- IPv6 network type.
- I(ipv6_network_type) is required if I(ipv6_enabled) is C(true).
- C(Static) to configure the static IP settings.
- C(DHCP) to configure the Dynamic IP settings.
type: str
ipv6_prefix_length:
description:
- IPV6 prefix length.
- I(ipv6_prefix_length) is required if I(ipv6_network_type) is C(Static).
type: int
password:
description:
- The password to login to the server or IOM.
- The module will always report change when I(password) option is added.
type: str
slots:
description: The slot configuration for the server or IOM.
elements: dict
suboptions:
slot_id:
description: The ID of the slot.
required: true
type: int
slot_ipv4_address:
description: The IPv4 address of the slot.
type: str
slot_ipv6_address:
description: The IPv6 address of the slot.
type: str
vlan_id:
description: The ID of the VLAN.
type: int
type: list
type: dict
error_info:
description: Details of the HTTP Error.
returned: on HTTP error
sample:
error:
'@Message.ExtendedInfo':
- Message: Unable to process the request because an error occurred.
MessageArgs: []
MessageId: GEN1234
RelatedProperties: []
Resolution: Retry the operation. If the issue persists, contact your system
administrator.
Severity: Critical
code: Base.1.0.GeneralError
message: A general error has occurred. See ExtendedInfo for more information.
type: dict
job_id:
description: The job ID of the submitted quick deploy job.
returned: when quick deploy job is submitted.
sample: 1234
type: int
msg:
description: Overall status of the device quick deploy settings.
returned: always
sample: Successfully deployed the quick deploy settings.
type: str
quick_deploy_settings:
description: returned when quick deploy settings are deployed successfully.
returned: success
sample:
DeviceId: 25011
IpV4Gateway: 192.168.0.1
IpV4SubnetMask: 255.255.255.0
IpV6Gateway: '::'
NetworkTypeV4: Static
NetworkTypeV6: Static
PrefixLength: '2'
ProtocolTypeV4: true
ProtocolTypeV6: true
SettingType: ServerQuickDeploy
slots:
- DeviceCapabilities:
- 18
- 17
- 16
- 15
- 14
- 13
- 12
- 11
- 10
- 9
- 41
- 8
- 7
- 4
- 3
- 2
- 1
- 31
- 30
DeviceIPV4Address: 192.168.0.2
DeviceIPV6Address: '::'
DeviceId: 25011
Dhcpipv4: Disabled
Dhcpipv6: Disabled
Ipv4Enabled: Enabled
Ipv6Enabled: Enabled
Model: PowerEdge MX840c
SlotIPV4Address: 192.168.0.2
SlotIPV6Address: '::'
SlotId: 1
SlotSelected: true
SlotSettingsApplied: true
SlotType: '2000'
Type: '1000'
VlanId: '1'
- DeviceId: 0
Model: ''
SlotIPV4Address: 0.0.0.0
SlotIPV6Address: '::'
SlotId: 2
SlotSelected: false
SlotSettingsApplied: false
SlotType: '2000'
Type: '0'
- DeviceId: 0
Model: ''
SlotIPV4Address: 0.0.0.0
SlotIPV6Address: '::'
SlotId: 3
SlotSelected: false
SlotSettingsApplied: false
SlotType: '2000'
Type: '0'
- DeviceId: 0
Model: ''
SlotIPV4Address: 0.0.0.0
SlotIPV6Address: '::'
SlotId: 4
SlotSelected: false
SlotSettingsApplied: false
SlotType: '2000'
Type: '0'
- DeviceId: 0
Model: ''
SlotIPV4Address: 0.0.0.0
SlotIPV6Address: '::'
SlotId: 5
SlotSelected: false
SlotSettingsApplied: false
SlotType: '2000'
Type: '0'
- DeviceId: 0
Model: ''
SlotIPV4Address: 0.0.0.0
SlotIPV6Address: '::'
SlotId: 6
SlotSelected: false
SlotSettingsApplied: false
SlotType: '2000'
Type: '0'
- DeviceId: 0
Model: ''
SlotIPV4Address: 0.0.0.0
SlotIPV6Address: '::'
SlotId: 7
SlotSelected: false
SlotSettingsApplied: false
SlotType: '2000'
Type: '0'
- DeviceId: 0
Model: ''
SlotIPV4Address: 0.0.0.0
SlotIPV6Address: '::'
SlotId: 8
SlotSelected: false
SlotSettingsApplied: false
SlotType: '2000'
Type: '0'
type: dict