sachaboudjema.arubaos.arubaos_set (0.1.2) — module

Add, modify or delete the configuration

| "added in version" 2.9.6 of sachaboudjema.arubaos"

Authors: Sacha Boudjema (@sachaboudjema)

preview | supported by community

Install collection

Install with ansible-galaxy collection install sachaboudjema.arubaos:==0.1.2


Add to requirements.yml

  collections:
    - name: sachaboudjema.arubaos
      version: 0.1.2

Description

Add, modify or delete the configuration.

Inputs

    
data:
    default: {}
    description:
    - One or more objects which needs to be set. Each object type is a keyn of the top
      level dict.
    - The SET request is best effort and in case of first failure, others in the same
      block are not even tried.
    - Each object can contain either a single instance (dict) or a list of instances (list
      of dicts).
    - Every object and sub-object can optionally contain an C(_action) field which describes
      the action napplied to the configuration.
    - If C(_action) field is not set it implies that the user wants to add/modify the
      configuration.
    - Toggle objects are set using the C(_present) field, which takes a bool value.
    - Mutually exclusive with C(multipart_data).
    required: false
    type: dict

host:
    description:
    - Hostname or IP Address of the controller.
    - If not set the environment variable C(ANSIBLE_ARUBAOS_HOST) will be used.
    required: true
    type: str

commit:
    default: false
    description:
    - If set to true, configuration changes will be commited (write memory) on the specified
      C(config_path).
    - Task will be skipped if any changes are pending prior to the operation.
    - Changes will not be commited if any configuration blocks in the set operation contain
      errors.
    - Changes will still be staged if commit is skipped due to block errors.
    - Mutually exclusive with C(commit_force) option.
    required: false
    type: bool

password:
    description:
    - Password used to login to the controller.
    - If not set the environment variable C(ANSIBLE_ARUBAOS_PASSWORD) will be used.
    no_log: true
    required: true
    type: str

username:
    description:
    - Username used to login to the controller.
    - If not set the environment variable C(ANSIBLE_ARUBAOS_USERNAME) will be used.
    required: true
    type: str

client_key:
    default: None
    description:
    - If the client_cert did not have the key, use this parameter. Default option is None.
    required: false
    type: str

client_cert:
    default: None
    description:
    - Set the file path for client certificate validation from server side. Default option
      is None.
    required: false
    type: str

config_path:
    default: None
    description:
    - Complete config-node or config-path to which the operation should be applied.
    - On a managed device this will be restricted to /mm/mynode.
    - On a stand-alone controller, this will be restricted to /mm and /mm/mynode.
    required: false
    type: str

commit_force:
    default: false
    description:
    - If set to true, any changes to the configuration will be commited (write memory)
      to the specified C(config_path).
    - Task will be skipped if any changes are pending prior to the operation.
    - Commmit will happen even if some configuration blocks in the set operation contain
      errors.
    - Mutually exclusive with C(commit) option.
    required: false
    type: bool

multipart_data:
    default: []
    description:
    - List of configuration data sets to be treated as independent requests.
    - Each item follows the same formating rules as for the C(data) option.
    - In contrary to C(data) option, even if one item (i.e. request) in the list contains
      errors, the other items will still continue to be processed.
    - Mutually exclusive with C(data).
    elements: dict
    required: false
    type: list

validate_certs:
    default: None
    description:
    - Set to True to validate server SSL certificate upon HTTPS connection. Default option
      is false.
    required: false
    type: str

See also