Vhg d d dl mZmZmZ eZdZdZdZd dl m
Z
m Z d dl m
Z
d Zedk( r e y y )
)absolute_importdivisionprint_functiona
---
module: aci_system
short_description: Query the ACI system information (top:System)
description:
- Query the ACI system information on Cisco ACI.
author:
- Lionel Hercot (@lhercot)
options:
id:
description:
- The controller node ID
aliases: [ controller, node ]
type: int
state:
description:
- Use C(query) for listing an object or multiple objects.
choices: [ query ]
default: query
type: str
notes:
- This module is used to query system information for both cloud and on-premises controllers.
seealso:
- name: APIC Management Information Model reference
description: More information about the internal APIC class B(top:System).
link: https://developer.cisco.com/docs/apic-mim-ref/
extends_documentation_fragment:
- cisco.aci.aci
a
- name: Query all controllers system information
cisco.aci.aci_system:
host: apic
username: userName
password: somePassword
validate_certs: false
state: query
delegate_to: localhost
- name: Query controller 1 specific system information
cisco.aci.aci_system:
host: apic
username: userName
password: somePassword
validate_certs: false
id: 1
state: query
delegate_to: localhost
a
current:
description: The existing configuration from the APIC after the module has finished
returned: success
type: list
sample:
[
{
"fvTenant": {
"attributes": {
"descr": "Production environment",
"dn": "uni/tn-production",
"name": "production",
"nameAlias": "",
"ownerKey": "",
"ownerTag": ""
}
}
}
]
error:
description: The error information as returned from the APIC
returned: failure
type: dict
sample:
{
"code": "122",
"text": "unknown managed object class foo"
}
raw:
description: The raw output returned by the APIC REST API (xml or json)
returned: parse error
type: str
sample: ''
sent:
description: The actual/minimal configuration pushed to the APIC
returned: info
type: list
sample:
{
"fvTenant": {
"attributes": {
"descr": "Production environment"
}
}
}
previous:
description: The original configuration from the APIC before the module has started
returned: info
type: list
sample:
[
{
"fvTenant": {
"attributes": {
"descr": "Production",
"dn": "uni/tn-production",
"name": "production",
"nameAlias": "",
"ownerKey": "",
"ownerTag": ""
}
}
}
]
proposed:
description: The assembled configuration from the user-provided parameters
returned: info
type: dict
sample:
{
"fvTenant": {
"attributes": {
"descr": "Production environment",
"name": "production"
}
}
}
filter_string:
description: The filter string used for the request
returned: failure or debug
type: str
sample: ?rsp-prop-include=config-only
method:
description: The HTTP method used for the request to the APIC
returned: failure or debug
type: str
sample: POST
response:
description: The HTTP response from the APIC
returned: failure or debug
type: str
sample: OK (30 bytes)
status:
description: The HTTP status from the APIC
returned: failure or debug
type: int
sample: 200
url:
description: The HTTP url used for the request to the APIC
returned: failure or debug
type: str
sample: https://10.11.12.13/api/mo/uni/tn-production.json
) ACIModuleaci_argument_spec)
AnsibleModulec V t } | j t dddg t dddg t | d
}|j j d }t
| }|j t d d |i
|j |j y )Nint
controllernode)typealiasesstrquery)r
defaultchoices)idstateT)
argument_specsupports_check_moder topSystem) aci_class
target_filter)
root_class)
r updatedictr paramsgetr
construct_url get_existing exit_json)r moduler acis h/home/dcms/DCMS/lib/python3.12/site-packages/ansible_collections/cisco/aci/plugins/modules/aci_system.pymainr% s %'M U\6$: ;w B
# F
4 B
F
C DRT:!VWMMO __main__N)
__future__r r r r
__metaclass__
DOCUMENTATIONEXAMPLESRETURN6ansible_collections.cisco.aci.plugins.module_utils.acir r ansible.module_utils.basicr r% __name__ r& r$ r1 sL A @
> *g
R ` 4, zF r&