Skip to content

Commit

Permalink
updated basic module-argument docs
Browse files Browse the repository at this point in the history
  • Loading branch information
ansibleguy committed Jan 1, 2024
1 parent 1088b6a commit 16e4685
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions docs/source/modules/1_basic.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,9 @@ All modules
"firewall","string","true","\-","\-","IP-Address or DNS hostname of the target firewall. Must be included as 'common name' or 'subject alternative name' in the firewalls web-certificate to use 'ssl_verify=true'"
"api_port","integer","false","443","\-","Port the target firewall uses for its web-interface"
"api_key","string","false, true if 'api_credential_file' is not used","\-","\-","API key used to authenticate, alternative to 'api_credential_file'"
"api_secret","string","false, "true" if 'api_credential_file' is not used","\-","\-","API secret used to authenticate, alternative to 'api_credential_file'. Is set as 'no_log' parameter"
"api_secret","string","false, true if 'api_credential_file' is not used","\-","\-","API secret used to authenticate, alternative to 'api_credential_file'. Is set as 'no_log' parameter"
"api_credential_file","path","false, true if 'api_key' and 'api_secret' are not used","\-","\-","Path to the api-credential file as downloaded through the web-interface. Alternative to 'api_key' and 'api_secret'"
"ssl_verify","bool","false","true","\-","If the certificate of the target firewall should be validated. RECOMMENDED FOR PRODUCTION USAGE!"
"ssl_verify","boolean","false","true","\-","If the certificate of the target firewall should be validated. RECOMMENDED FOR PRODUCTION USAGE!"
"ssl_ca_file","path","false","\-","\-","If you use an internal certificate-authority to create the certificate of the target firewall, provide the path to its public key for validation"
"debug","boolean","false","false","\-","Used to en-/disable the debug mode. All API requests and responses will be shown as Ansible warnings at runtime. Will be hidden if the tasks 'no_log' parameter is set to 'true'"
"profiling","boolean","false","false","\-","Used to en-/disable the profiling mode. Time consumption of the module will be logged to '/tmp/ansibleguy.opnsense'"
Expand Down

0 comments on commit 16e4685

Please sign in to comment.