Skip to content

Commit

Permalink
Update documentation for alias
Browse files Browse the repository at this point in the history
  • Loading branch information
jiuka authored and ansibleguy committed Oct 6, 2024
1 parent a930754 commit 2079bec
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 1 deletion.
2 changes: 2 additions & 0 deletions docs/source/modules/alias.rst
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,7 @@ Definition
"content","list","false for state changes, else true","\-","cont, c","Values the alias should hold"
"type","string","false","'host'","t","Type of value the alias should hold. One of: 'host', 'network', 'port', 'url', 'urltable', 'geoip', 'networkgroup', 'mac', 'dynipv6host', 'internal', 'external'"
"updatefreq_days","float","false","7.0","\-","Needed only for the alias-type 'urltable'. Interval to update its content. Per example: 0.5 for every 12 hours"
"interface","string","false","\-","int, if","Needed only for the alias-type 'dynipv6host'. Select the interface for the V6 dynamic IP"
"reload","boolean","false","false","\-", .. include:: ../_include/param_reload.rst

.. include:: ../_include/param_basic.rst
Expand Down Expand Up @@ -73,6 +74,7 @@ Examples
state: 'present'
# type: 'host' # default
# updatefreq_days: 3 # used only for type 'urltable'
# interface: lan # used only for the type 'dynipv6host'
# ssl_ca_file: '/etc/ssl/certs/custom/ca.crt'
# ssl_verify: False
# api_key: !vault ... # alternative to 'api_credential_file'
Expand Down
2 changes: 1 addition & 1 deletion plugins/module_utils/defaults/alias.py
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
'description': ['desc'],
'state': ['st'],
'enabled': ['en'],
'interface': ['int']
'interface': ['int', 'if']
}

ALIAS_MOD_ARGS = dict(
Expand Down

0 comments on commit 2079bec

Please sign in to comment.