ansible.builtin.aci_firmware_policy (v2.9.0) — module

This creates a firmware policy

| "added in version" 2.8 of ansible.builtin"

Authors: Steven Gerhart (@sgerhart)

preview | supported by community

Install Ansible via pip

Install with pip install ansible==2.9.0

Description

This module creates a firmware policy for firmware groups. The firmware policy is create first and then

referenced by the firmware group. You will assign the firmware and specify if you want to ignore the compatibility

check

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
   - name: firmware policy
     aci_firmware_policy:
        host: "{{ inventory_hostname }}"
        username: "{{ user }}"
        password: "{{ pass }}"
        validate_certs: no
        name: test2FrmPol
        version: n9000-13.2(1m)
        ignoreCompat: False
        state: present

Inputs

    
host:
    aliases:
    - hostname
    description:
    - IP Address or hostname of APIC resolvable by Ansible control host.
    required: true
    type: str

name:
    description:
    - Name of the firmware policy
    required: true

port:
    description:
    - Port number to be used for REST connection.
    - The default value depends on parameter C(use_ssl).
    type: int

state:
    choices:
    - absent
    - present
    - query
    default: present
    description:
    - Use C(present) or C(absent) for adding or removing.
    - Use C(query) for listing an object or multiple objects.

timeout:
    default: 30
    description:
    - The socket level timeout in seconds.
    type: int

use_ssl:
    default: true
    description:
    - If C(no), an HTTP connection will be used instead of the default HTTPS connection.
    type: bool

version:
    description:
    - The version of the firmware associated with this policy. This value is very import
      as well as constructing
    - it correctly. The syntax for this field is n9000-xx.x. If you look at the firmware
      repository using the UI
    - each version will have a "Full Version" column, this is the value you need to use.
      So, if the Full Version
    - is 13.1(1i), the value for this field would be n9000-13.1(1i)
    required: true

password:
    description:
    - The password to use for authentication.
    - This option is mutual exclusive with C(private_key). If C(private_key) is provided
      too, it will be used instead.
    required: true
    type: str

username:
    aliases:
    - user
    default: admin
    description:
    - The username to use for authentication.
    type: str

use_proxy:
    default: true
    description:
    - If C(no), it will not use a proxy, even if one is defined in an environment variable
      on the target hosts.
    type: bool

private_key:
    aliases:
    - cert_key
    description:
    - Either a PEM-formatted private key file or the private key content used for signature-based
      authentication.
    - This value also influences the default C(certificate_name) that is used.
    - This option is mutual exclusive with C(password). If C(password) is provided too,
      it will be ignored.
    required: true
    type: str

ignoreCompat:
    description:
    - Check if compatibility checks should be ignored
    required: false

output_level:
    choices:
    - debug
    - info
    - normal
    default: normal
    description:
    - Influence the output of this ACI module.
    - C(normal) means the standard output, incl. C(current) dict
    - C(info) adds informational output, incl. C(previous), C(proposed) and C(sent) dicts
    - C(debug) adds debugging output, incl. C(filter_string), C(method), C(response),
      C(status) and C(url) information
    type: str

validate_certs:
    default: true
    description:
    - If C(no), SSL certificates will not be validated.
    - This should only set to C(no) when used on personally controlled sites using self-signed
      certificates.
    type: bool

certificate_name:
    aliases:
    - cert_name
    description:
    - The X.509 certificate name attached to the APIC AAA user used for signature-based
      authentication.
    - If a C(private_key) filename was provided, this defaults to the C(private_key) basename,
      without extension.
    - If PEM-formatted content was provided for C(private_key), this defaults to the C(username)
      value.
    type: str

Outputs

current:
  description: The existing configuration from the APIC after the module has finished
  returned: success
  sample:
  - fvTenant:
      attributes:
        descr: Production environment
        dn: uni/tn-production
        name: production
        nameAlias: ''
        ownerKey: ''
        ownerTag: ''
  type: list
error:
  description: The error information as returned from the APIC
  returned: failure
  sample:
    code: '122'
    text: unknown managed object class foo
  type: dict
filter_string:
  description: The filter string used for the request
  returned: failure or debug
  sample: ?rsp-prop-include=config-only
  type: str
method:
  description: The HTTP method used for the request to the APIC
  returned: failure or debug
  sample: POST
  type: str
previous:
  description: The original configuration from the APIC before the module has started
  returned: info
  sample:
  - fvTenant:
      attributes:
        descr: Production
        dn: uni/tn-production
        name: production
        nameAlias: ''
        ownerKey: ''
        ownerTag: ''
  type: list
proposed:
  description: The assembled configuration from the user-provided parameters
  returned: info
  sample:
    fvTenant:
      attributes:
        descr: Production environment
        name: production
  type: dict
raw:
  description: The raw output returned by the APIC REST API (xml or json)
  returned: parse error
  sample: <?xml version="1.0" encoding="UTF-8"?><imdata totalCount="1"><error code="122"
    text="unknown managed object class foo"/></imdata>
  type: str
response:
  description: The HTTP response from the APIC
  returned: failure or debug
  sample: OK (30 bytes)
  type: str
sent:
  description: The actual/minimal configuration pushed to the APIC
  returned: info
  sample:
    fvTenant:
      attributes:
        descr: Production environment
  type: list
status:
  description: The HTTP status from the APIC
  returned: failure or debug
  sample: 200
  type: int
url:
  description: The HTTP url used for the request to the APIC
  returned: failure or debug
  sample: https://10.11.12.13/api/mo/uni/tn-production.json
  type: str

See also