mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-07-23 05:10:22 -07:00
modules: fix examples to use FQCN (#644)
* modules: fix examples to use FQCN * fix * fix * fix
This commit is contained in:
parent
8b92e0454d
commit
41cfdda6a3
533 changed files with 2130 additions and 2130 deletions
|
@ -58,7 +58,7 @@ author: "Jose Delarosa (@jose-delarosa)"
|
|||
|
||||
EXAMPLES = '''
|
||||
- name: Create BIOS configuration job (schedule BIOS setting update)
|
||||
idrac_redfish_command:
|
||||
community.general.idrac_redfish_command:
|
||||
category: Systems
|
||||
command: CreateBiosConfigJob
|
||||
resource_id: System.Embedded.1
|
||||
|
|
|
@ -78,7 +78,7 @@ author: "Jose Delarosa (@jose-delarosa)"
|
|||
|
||||
EXAMPLES = '''
|
||||
- name: Enable NTP and set NTP server and Time zone attributes in iDRAC
|
||||
idrac_redfish_config:
|
||||
community.general.idrac_redfish_config:
|
||||
category: Manager
|
||||
command: SetManagerAttributes
|
||||
resource_id: iDRAC.Embedded.1
|
||||
|
@ -91,7 +91,7 @@ EXAMPLES = '''
|
|||
password: "{{ password }}"
|
||||
|
||||
- name: Enable Syslog and set Syslog servers in iDRAC
|
||||
idrac_redfish_config:
|
||||
community.general.idrac_redfish_config:
|
||||
category: Manager
|
||||
command: SetManagerAttributes
|
||||
resource_id: iDRAC.Embedded.1
|
||||
|
@ -104,7 +104,7 @@ EXAMPLES = '''
|
|||
password: "{{ password }}"
|
||||
|
||||
- name: Configure SNMP community string, port, protocol and trap format
|
||||
idrac_redfish_config:
|
||||
community.general.idrac_redfish_config:
|
||||
category: Manager
|
||||
command: SetManagerAttributes
|
||||
resource_id: iDRAC.Embedded.1
|
||||
|
@ -120,7 +120,7 @@ EXAMPLES = '''
|
|||
password: "{{ password }}"
|
||||
|
||||
- name: Enable CSIOR
|
||||
idrac_redfish_config:
|
||||
community.general.idrac_redfish_config:
|
||||
category: Manager
|
||||
command: SetLifecycleControllerAttributes
|
||||
resource_id: iDRAC.Embedded.1
|
||||
|
@ -131,7 +131,7 @@ EXAMPLES = '''
|
|||
password: "{{ password }}"
|
||||
|
||||
- name: Set Power Supply Redundancy Policy to A/B Grid Redundant
|
||||
idrac_redfish_config:
|
||||
community.general.idrac_redfish_config:
|
||||
category: Manager
|
||||
command: SetSystemAttributes
|
||||
resource_id: iDRAC.Embedded.1
|
||||
|
|
|
@ -56,7 +56,7 @@ author: "Jose Delarosa (@jose-delarosa)"
|
|||
|
||||
EXAMPLES = '''
|
||||
- name: Get Manager attributes with a default of 20 seconds
|
||||
idrac_redfish_info:
|
||||
community.general.idrac_redfish_info:
|
||||
category: Manager
|
||||
command: GetManagerAttributes
|
||||
baseuri: "{{ baseuri }}"
|
||||
|
|
|
@ -198,7 +198,7 @@ author: "Jose Delarosa (@jose-delarosa)"
|
|||
|
||||
EXAMPLES = '''
|
||||
- name: Restart system power gracefully
|
||||
redfish_command:
|
||||
community.general.redfish_command:
|
||||
category: Systems
|
||||
command: PowerGracefulRestart
|
||||
resource_id: 437XR1138R2
|
||||
|
@ -207,7 +207,7 @@ EXAMPLES = '''
|
|||
password: "{{ password }}"
|
||||
|
||||
- name: Set one-time boot device to {{ bootdevice }}
|
||||
redfish_command:
|
||||
community.general.redfish_command:
|
||||
category: Systems
|
||||
command: SetOneTimeBoot
|
||||
resource_id: 437XR1138R2
|
||||
|
@ -217,7 +217,7 @@ EXAMPLES = '''
|
|||
password: "{{ password }}"
|
||||
|
||||
- name: Set one-time boot device to UefiTarget of "/0x31/0x33/0x01/0x01"
|
||||
redfish_command:
|
||||
community.general.redfish_command:
|
||||
category: Systems
|
||||
command: SetOneTimeBoot
|
||||
resource_id: 437XR1138R2
|
||||
|
@ -228,7 +228,7 @@ EXAMPLES = '''
|
|||
password: "{{ password }}"
|
||||
|
||||
- name: Set one-time boot device to BootNext target of "Boot0001"
|
||||
redfish_command:
|
||||
community.general.redfish_command:
|
||||
category: Systems
|
||||
command: SetOneTimeBoot
|
||||
resource_id: 437XR1138R2
|
||||
|
@ -239,7 +239,7 @@ EXAMPLES = '''
|
|||
password: "{{ password }}"
|
||||
|
||||
- name: Set chassis indicator LED to blink
|
||||
redfish_command:
|
||||
community.general.redfish_command:
|
||||
category: Chassis
|
||||
command: IndicatorLedBlink
|
||||
resource_id: 1U
|
||||
|
@ -248,7 +248,7 @@ EXAMPLES = '''
|
|||
password: "{{ password }}"
|
||||
|
||||
- name: Add user
|
||||
redfish_command:
|
||||
community.general.redfish_command:
|
||||
category: Accounts
|
||||
command: AddUser
|
||||
baseuri: "{{ baseuri }}"
|
||||
|
@ -259,7 +259,7 @@ EXAMPLES = '''
|
|||
roleid: "{{ roleid }}"
|
||||
|
||||
- name: Add user using new option aliases
|
||||
redfish_command:
|
||||
community.general.redfish_command:
|
||||
category: Accounts
|
||||
command: AddUser
|
||||
baseuri: "{{ baseuri }}"
|
||||
|
@ -270,7 +270,7 @@ EXAMPLES = '''
|
|||
account_roleid: "{{ account_roleid }}"
|
||||
|
||||
- name: Delete user
|
||||
redfish_command:
|
||||
community.general.redfish_command:
|
||||
category: Accounts
|
||||
command: DeleteUser
|
||||
baseuri: "{{ baseuri }}"
|
||||
|
@ -279,7 +279,7 @@ EXAMPLES = '''
|
|||
account_username: "{{ account_username }}"
|
||||
|
||||
- name: Disable user
|
||||
redfish_command:
|
||||
community.general.redfish_command:
|
||||
category: Accounts
|
||||
command: DisableUser
|
||||
baseuri: "{{ baseuri }}"
|
||||
|
@ -288,7 +288,7 @@ EXAMPLES = '''
|
|||
account_username: "{{ account_username }}"
|
||||
|
||||
- name: Enable user
|
||||
redfish_command:
|
||||
community.general.redfish_command:
|
||||
category: Accounts
|
||||
command: EnableUser
|
||||
baseuri: "{{ baseuri }}"
|
||||
|
@ -297,7 +297,7 @@ EXAMPLES = '''
|
|||
account_username: "{{ account_username }}"
|
||||
|
||||
- name: Add and enable user
|
||||
redfish_command:
|
||||
community.general.redfish_command:
|
||||
category: Accounts
|
||||
command: AddUser,EnableUser
|
||||
baseuri: "{{ baseuri }}"
|
||||
|
@ -308,7 +308,7 @@ EXAMPLES = '''
|
|||
roleid: "{{ roleid }}"
|
||||
|
||||
- name: Update user password
|
||||
redfish_command:
|
||||
community.general.redfish_command:
|
||||
category: Accounts
|
||||
command: UpdateUserPassword
|
||||
baseuri: "{{ baseuri }}"
|
||||
|
@ -318,7 +318,7 @@ EXAMPLES = '''
|
|||
account_password: "{{ account_password }}"
|
||||
|
||||
- name: Update user role
|
||||
redfish_command:
|
||||
community.general.redfish_command:
|
||||
category: Accounts
|
||||
command: UpdateUserRole
|
||||
baseuri: "{{ baseuri }}"
|
||||
|
@ -328,7 +328,7 @@ EXAMPLES = '''
|
|||
roleid: "{{ roleid }}"
|
||||
|
||||
- name: Update user name
|
||||
redfish_command:
|
||||
community.general.redfish_command:
|
||||
category: Accounts
|
||||
command: UpdateUserName
|
||||
baseuri: "{{ baseuri }}"
|
||||
|
@ -338,7 +338,7 @@ EXAMPLES = '''
|
|||
account_updatename: "{{ account_updatename }}"
|
||||
|
||||
- name: Update user name
|
||||
redfish_command:
|
||||
community.general.redfish_command:
|
||||
category: Accounts
|
||||
command: UpdateUserName
|
||||
baseuri: "{{ baseuri }}"
|
||||
|
@ -348,7 +348,7 @@ EXAMPLES = '''
|
|||
update_username: "{{ update_username }}"
|
||||
|
||||
- name: Update AccountService properties
|
||||
redfish_command:
|
||||
community.general.redfish_command:
|
||||
category: Accounts
|
||||
command: UpdateAccountServiceProperties
|
||||
baseuri: "{{ baseuri }}"
|
||||
|
@ -359,7 +359,7 @@ EXAMPLES = '''
|
|||
AccountLockoutDuration: 600
|
||||
|
||||
- name: Clear Manager Logs with a timeout of 20 seconds
|
||||
redfish_command:
|
||||
community.general.redfish_command:
|
||||
category: Manager
|
||||
command: ClearLogs
|
||||
resource_id: BMC
|
||||
|
@ -369,7 +369,7 @@ EXAMPLES = '''
|
|||
timeout: 20
|
||||
|
||||
- name: Clear Sessions
|
||||
redfish_command:
|
||||
community.general.redfish_command:
|
||||
category: Sessions
|
||||
command: ClearSessions
|
||||
baseuri: "{{ baseuri }}"
|
||||
|
@ -377,7 +377,7 @@ EXAMPLES = '''
|
|||
password: "{{ password }}"
|
||||
|
||||
- name: Simple update
|
||||
redfish_command:
|
||||
community.general.redfish_command:
|
||||
category: Update
|
||||
command: SimpleUpdate
|
||||
baseuri: "{{ baseuri }}"
|
||||
|
@ -386,7 +386,7 @@ EXAMPLES = '''
|
|||
update_image_uri: https://example.com/myupdate.img
|
||||
|
||||
- name: Simple update with additional options
|
||||
redfish_command:
|
||||
community.general.redfish_command:
|
||||
category: Update
|
||||
command: SimpleUpdate
|
||||
baseuri: "{{ baseuri }}"
|
||||
|
@ -401,7 +401,7 @@ EXAMPLES = '''
|
|||
password: supersecretpwd
|
||||
|
||||
- name: Insert Virtual Media
|
||||
redfish_command:
|
||||
community.general.redfish_command:
|
||||
category: Manager
|
||||
command: VirtualMediaInsert
|
||||
baseuri: "{{ baseuri }}"
|
||||
|
@ -415,7 +415,7 @@ EXAMPLES = '''
|
|||
resource_id: BMC
|
||||
|
||||
- name: Eject Virtual Media
|
||||
redfish_command:
|
||||
community.general.redfish_command:
|
||||
category: Manager
|
||||
command: VirtualMediaEject
|
||||
baseuri: "{{ baseuri }}"
|
||||
|
|
|
@ -104,7 +104,7 @@ author: "Jose Delarosa (@jose-delarosa)"
|
|||
|
||||
EXAMPLES = '''
|
||||
- name: Set BootMode to UEFI
|
||||
redfish_config:
|
||||
community.general.redfish_config:
|
||||
category: Systems
|
||||
command: SetBiosAttributes
|
||||
resource_id: 437XR1138R2
|
||||
|
@ -115,7 +115,7 @@ EXAMPLES = '''
|
|||
password: "{{ password }}"
|
||||
|
||||
- name: Set multiple BootMode attributes
|
||||
redfish_config:
|
||||
community.general.redfish_config:
|
||||
category: Systems
|
||||
command: SetBiosAttributes
|
||||
resource_id: 437XR1138R2
|
||||
|
@ -128,7 +128,7 @@ EXAMPLES = '''
|
|||
password: "{{ password }}"
|
||||
|
||||
- name: Enable PXE Boot for NIC1 using deprecated options
|
||||
redfish_config:
|
||||
community.general.redfish_config:
|
||||
category: Systems
|
||||
command: SetBiosAttributes
|
||||
resource_id: 437XR1138R2
|
||||
|
@ -139,7 +139,7 @@ EXAMPLES = '''
|
|||
password: "{{ password }}"
|
||||
|
||||
- name: Set BIOS default settings with a timeout of 20 seconds
|
||||
redfish_config:
|
||||
community.general.redfish_config:
|
||||
category: Systems
|
||||
command: SetBiosDefaultSettings
|
||||
resource_id: 437XR1138R2
|
||||
|
@ -149,7 +149,7 @@ EXAMPLES = '''
|
|||
timeout: 20
|
||||
|
||||
- name: Set boot order
|
||||
redfish_config:
|
||||
community.general.redfish_config:
|
||||
category: Systems
|
||||
command: SetBootOrder
|
||||
boot_order:
|
||||
|
@ -163,7 +163,7 @@ EXAMPLES = '''
|
|||
password: "{{ password }}"
|
||||
|
||||
- name: Set boot order to the default
|
||||
redfish_config:
|
||||
community.general.redfish_config:
|
||||
category: Systems
|
||||
command: SetDefaultBootOrder
|
||||
baseuri: "{{ baseuri }}"
|
||||
|
@ -171,7 +171,7 @@ EXAMPLES = '''
|
|||
password: "{{ password }}"
|
||||
|
||||
- name: Set Manager Network Protocols
|
||||
redfish_config:
|
||||
community.general.redfish_config:
|
||||
category: Manager
|
||||
command: SetNetworkProtocols
|
||||
network_protocols:
|
||||
|
@ -186,7 +186,7 @@ EXAMPLES = '''
|
|||
password: "{{ password }}"
|
||||
|
||||
- name: Set Manager NIC
|
||||
redfish_config:
|
||||
community.general.redfish_config:
|
||||
category: Manager
|
||||
command: SetManagerNic
|
||||
nic_config:
|
||||
|
|
|
@ -55,7 +55,7 @@ author: "Jose Delarosa (@jose-delarosa)"
|
|||
|
||||
EXAMPLES = '''
|
||||
- name: Get CPU inventory
|
||||
redfish_info:
|
||||
community.general.redfish_info:
|
||||
category: Systems
|
||||
command: GetCpuInventory
|
||||
baseuri: "{{ baseuri }}"
|
||||
|
@ -66,7 +66,7 @@ EXAMPLES = '''
|
|||
msg: "{{ result.redfish_facts.cpu.entries | to_nice_json }}"
|
||||
|
||||
- name: Get CPU model
|
||||
redfish_info:
|
||||
community.general.redfish_info:
|
||||
category: Systems
|
||||
command: GetCpuInventory
|
||||
baseuri: "{{ baseuri }}"
|
||||
|
@ -77,7 +77,7 @@ EXAMPLES = '''
|
|||
msg: "{{ result.redfish_facts.cpu.entries.0.Model }}"
|
||||
|
||||
- name: Get memory inventory
|
||||
redfish_info:
|
||||
community.general.redfish_info:
|
||||
category: Systems
|
||||
command: GetMemoryInventory
|
||||
baseuri: "{{ baseuri }}"
|
||||
|
@ -86,7 +86,7 @@ EXAMPLES = '''
|
|||
register: result
|
||||
|
||||
- name: Get fan inventory with a timeout of 20 seconds
|
||||
redfish_info:
|
||||
community.general.redfish_info:
|
||||
category: Chassis
|
||||
command: GetFanInventory
|
||||
baseuri: "{{ baseuri }}"
|
||||
|
@ -96,7 +96,7 @@ EXAMPLES = '''
|
|||
register: result
|
||||
|
||||
- name: Get Virtual Media information
|
||||
redfish_info:
|
||||
community.general.redfish_info:
|
||||
category: Manager
|
||||
command: GetVirtualMedia
|
||||
baseuri: "{{ baseuri }}"
|
||||
|
@ -107,7 +107,7 @@ EXAMPLES = '''
|
|||
msg: "{{ result.redfish_facts.virtual_media.entries | to_nice_json }}"
|
||||
|
||||
- name: Get Volume Inventory
|
||||
redfish_info:
|
||||
community.general.redfish_info:
|
||||
category: Systems
|
||||
command: GetVolumeInventory
|
||||
baseuri: "{{ baseuri }}"
|
||||
|
@ -118,7 +118,7 @@ EXAMPLES = '''
|
|||
msg: "{{ result.redfish_facts.volume.entries | to_nice_json }}"
|
||||
|
||||
- name: Get Session information
|
||||
redfish_info:
|
||||
community.general.redfish_info:
|
||||
category: Sessions
|
||||
command: GetSessions
|
||||
baseuri: "{{ baseuri }}"
|
||||
|
@ -129,7 +129,7 @@ EXAMPLES = '''
|
|||
msg: "{{ result.redfish_facts.session.entries | to_nice_json }}"
|
||||
|
||||
- name: Get default inventory information
|
||||
redfish_info:
|
||||
community.general.redfish_info:
|
||||
baseuri: "{{ baseuri }}"
|
||||
username: "{{ username }}"
|
||||
password: "{{ password }}"
|
||||
|
@ -138,7 +138,7 @@ EXAMPLES = '''
|
|||
msg: "{{ result.redfish_facts | to_nice_json }}"
|
||||
|
||||
- name: Get several inventories
|
||||
redfish_info:
|
||||
community.general.redfish_info:
|
||||
category: Systems
|
||||
command: GetNicInventory,GetBiosAttributes
|
||||
baseuri: "{{ baseuri }}"
|
||||
|
@ -146,21 +146,21 @@ EXAMPLES = '''
|
|||
password: "{{ password }}"
|
||||
|
||||
- name: Get default system inventory and user information
|
||||
redfish_info:
|
||||
community.general.redfish_info:
|
||||
category: Systems,Accounts
|
||||
baseuri: "{{ baseuri }}"
|
||||
username: "{{ username }}"
|
||||
password: "{{ password }}"
|
||||
|
||||
- name: Get default system, user and firmware information
|
||||
redfish_info:
|
||||
community.general.redfish_info:
|
||||
category: ["Systems", "Accounts", "Update"]
|
||||
baseuri: "{{ baseuri }}"
|
||||
username: "{{ username }}"
|
||||
password: "{{ password }}"
|
||||
|
||||
- name: Get Manager NIC inventory information
|
||||
redfish_info:
|
||||
community.general.redfish_info:
|
||||
category: Manager
|
||||
command: GetManagerNicInventory
|
||||
baseuri: "{{ baseuri }}"
|
||||
|
@ -168,7 +168,7 @@ EXAMPLES = '''
|
|||
password: "{{ password }}"
|
||||
|
||||
- name: Get boot override information
|
||||
redfish_info:
|
||||
community.general.redfish_info:
|
||||
category: Systems
|
||||
command: GetBootOverride
|
||||
baseuri: "{{ baseuri }}"
|
||||
|
@ -176,7 +176,7 @@ EXAMPLES = '''
|
|||
password: "{{ password }}"
|
||||
|
||||
- name: Get chassis inventory
|
||||
redfish_info:
|
||||
community.general.redfish_info:
|
||||
category: Chassis
|
||||
command: GetChassisInventory
|
||||
baseuri: "{{ baseuri }}"
|
||||
|
@ -184,7 +184,7 @@ EXAMPLES = '''
|
|||
password: "{{ password }}"
|
||||
|
||||
- name: Get all information available in the Manager category
|
||||
redfish_info:
|
||||
community.general.redfish_info:
|
||||
category: Manager
|
||||
command: all
|
||||
baseuri: "{{ baseuri }}"
|
||||
|
@ -192,7 +192,7 @@ EXAMPLES = '''
|
|||
password: "{{ password }}"
|
||||
|
||||
- name: Get firmware update capability information
|
||||
redfish_info:
|
||||
community.general.redfish_info:
|
||||
category: Update
|
||||
command: GetFirmwareUpdateCapabilities
|
||||
baseuri: "{{ baseuri }}"
|
||||
|
@ -200,7 +200,7 @@ EXAMPLES = '''
|
|||
password: "{{ password }}"
|
||||
|
||||
- name: Get firmware inventory
|
||||
redfish_info:
|
||||
community.general.redfish_info:
|
||||
category: Update
|
||||
command: GetFirmwareInventory
|
||||
baseuri: "{{ baseuri }}"
|
||||
|
@ -208,7 +208,7 @@ EXAMPLES = '''
|
|||
password: "{{ password }}"
|
||||
|
||||
- name: Get software inventory
|
||||
redfish_info:
|
||||
community.general.redfish_info:
|
||||
category: Update
|
||||
command: GetSoftwareInventory
|
||||
baseuri: "{{ baseuri }}"
|
||||
|
@ -216,7 +216,7 @@ EXAMPLES = '''
|
|||
password: "{{ password }}"
|
||||
|
||||
- name: Get Manager Services
|
||||
redfish_info:
|
||||
community.general.redfish_info:
|
||||
category: Manager
|
||||
command: GetNetworkProtocols
|
||||
baseuri: "{{ baseuri }}"
|
||||
|
@ -224,7 +224,7 @@ EXAMPLES = '''
|
|||
password: "{{ password }}"
|
||||
|
||||
- name: Get all information available in all categories
|
||||
redfish_info:
|
||||
community.general.redfish_info:
|
||||
category: all
|
||||
command: all
|
||||
baseuri: "{{ baseuri }}"
|
||||
|
@ -232,7 +232,7 @@ EXAMPLES = '''
|
|||
password: "{{ password }}"
|
||||
|
||||
- name: Get system health report
|
||||
redfish_info:
|
||||
community.general.redfish_info:
|
||||
category: Systems
|
||||
command: GetHealthReport
|
||||
baseuri: "{{ baseuri }}"
|
||||
|
@ -240,7 +240,7 @@ EXAMPLES = '''
|
|||
password: "{{ password }}"
|
||||
|
||||
- name: Get chassis health report
|
||||
redfish_info:
|
||||
community.general.redfish_info:
|
||||
category: Chassis
|
||||
command: GetHealthReport
|
||||
baseuri: "{{ baseuri }}"
|
||||
|
@ -248,7 +248,7 @@ EXAMPLES = '''
|
|||
password: "{{ password }}"
|
||||
|
||||
- name: Get manager health report
|
||||
redfish_info:
|
||||
community.general.redfish_info:
|
||||
category: Manager
|
||||
command: GetHealthReport
|
||||
baseuri: "{{ baseuri }}"
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue