Skip default params from every module in a collection

sumanth-lingappa · January 6, 2024, 5:45am

I am the maintainer of netscaler.adc ansible collection.

Every module in this collection is an API call to the NetScaler ADC device to configure it.

Every module has some common params (attributes) which have to be present in the playbook-task (OR optionally, environment variable also can be read)

common params are: nsip, nitro_user, nitro_pass, nitro_protocol, validate_certs, save_config

Is there any way I can enhance my collection to skip (or specifiy) these common params in the playbook?

Thank you

Eg can be found in the below file

github.com

netscaler/ansible-collection-netscaleradc/blob/main/examples/lbvserver.yaml

---
- name: Simple LBVserver playbook
  hosts: localhost
  gather_facts: false
  tasks:
    - name: Sample Task | service
      delegate_to: localhost
      netscaler.adc.service:
        # nsip: 10.0.0.1 # This can also be given via NETSCALER_NSIP environment variable
        # nitro_user: nitrouser # This can also be given via NETSCALER_NITRO_USER environment variable
        # nitro_pass: verysecretpassword # This can also be given via NETSCALER_NITRO_PASS environment variable
        # nitro_protocol: https # This can also be given via NETSCALER_NITRO_PROTOCOL environment variable
        # validate_certs: false # This can also be given via NETSCALER_VALIDATE_CERTS environment variable
        # save_config: false # This can also be given via NETSCALER_SAVE_CONFIG environment variable
        state: present
        name: s1
        ipaddress: 10.10.10.181
        servicetype: HTTP
        port: 80
    - name: Sample Task | service

This file has been truncated. show original

felixfontein · January 6, 2024, 7:46am

You can use module default groups, also known as action groups: Module defaults — Ansible Documentation

Example of a collection using that:

community.routeros/meta/runtime.yml at main · ansible-collections/community.routeros · GitHub
How to connect to RouterOS devices with the RouterOS API — Community.Routeros Collection documentation

sumanth-lingappa · January 7, 2024, 2:38pm

Thank you @felixfontein as always

sumanth-lingappa · January 8, 2024, 8:14am

Hello @felixfontein, is there a way I can use module defaults in my integration tests (using roles) ?

system · February 7, 2024, 8:15am

This topic was automatically closed 30 days after the last reply. New replies are no longer allowed.