java.lang.Object
- it.andreascarpino.ansible.inventory.type.AnsibleConstants

public final class AnsibleConstants
extends Object

Author:: Andrea Scarpino

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static class`	`AnsibleConstants.AnsibleConnection`
`static class`	`AnsibleConstants.AnsibleWinRMScheme`
`static class`	`AnsibleConstants.AnsibleWinRMServerCertValidation`
`static class`	`AnsibleConstants.AnsibleWinRMTransport`

Field Summary

Fields
Modifier and Type	Field	Description
`static String`	`ALL_GROUP`	Default group that contains all hosts in the inventory.
`static String`	`ANSIBLE_BECOME`	Equivalent to `ansible_sudo` or `ansible_su`, allows to force privilege escalation.
`static String`	`ANSIBLE_BECOME_METHOD`	Allows to set privilege escalation method.
`static String`	`ANSIBLE_BECOME_PASS`	Equivalent to `ansible_sudo_pass` or `ansible_su_pass`, allows you to set the privilege escalation password.
`static String`	`ANSIBLE_BECOME_USER`	Equivalent to `ansible_sudo_user` or `ansible_su_user`, allows to set the user you become through privilege escalation.
`static String`	`ANSIBLE_CONNECTION`	Connection type to the host.
`static String`	`ANSIBLE_HOST`	The name of the host to connect to, if different from the alias you wish to give to it.
`static String`	`ANSIBLE_PASSWORD`	The user password to use (this is insecure, we strongly recommend using `--ask-pass` or SSH keys).
`static String`	`ANSIBLE_PORT`	The ssh port number, if not 22.
`static String`	`ANSIBLE_PYTHON_INTERPRETER`	The target host python path.
`static String`	`ANSIBLE_SCP_EXTRA_ARGS`	This setting is always appended to the default scp command line.
`static String`	`ANSIBLE_SFTP_EXTRA_ARGS`	This setting is always appended to the default sftp command line.
`static String`	`ANSIBLE_SHELL_TYPE`	The shell type of the target system.
`static String`	`ANSIBLE_SSH_COMMON_ARGS`	This setting is always appended to the default command line for sftp, scp, and ssh.
`static String`	`ANSIBLE_SSH_EXTRA_ARGS`	This setting is always appended to the default ssh command line.
`static String`	`ANSIBLE_SSH_PIPELINING`	Determines whether or not to use SSH pipelining.
`static String`	`ANSIBLE_SSH_PRIVATE_KEY_FILE`	Private key file used by ssh.
`static String`	`ANSIBLE_USER`	The default ssh user name to use.
`static String`	`ANSIBLE_WINRM_KERBEROS_DELEGATION`	Set to true to enable delegation of commands on the remote host when using kerberos.
`static String`	`ANSIBLE_WINRM_KERBEROS_HOSTNAME_OVERRIDE`	The hostname to use for the kerberos exchange (defaults to the hostname in the endpoint URL).
`static String`	`ANSIBLE_WINRM_OPERATION_TIMEOUT_SEC`	Maximum allowed time in seconds for any single wsman HTTP operation (default 20).
`static String`	`ANSIBLE_WINRM_PATH`	Specify an alternate path to the WinRM endpoint.
`static String`	`ANSIBLE_WINRM_READ_TIMEOUT_SEC`	Maximum seconds to wait before an HTTP connect/read times out (default 30).
`static String`	`ANSIBLE_WINRM_REALM`	Specify the realm to use for Kerberos authentication.
`static String`	`ANSIBLE_WINRM_SCHEME`	Specify the connection scheme (`http` or `https`) to use for the WinRM connection.
`static String`	`ANSIBLE_WINRM_SERVER_CERT_VALIDATION`	Specify the server certificate validation mode (`ignore` or `validate`).
`static String`	`ANSIBLE_WINRM_TRANSPORT`	Specify one or more transports as a comma-separated list.

Method Summary
- Methods inherited from class java.lang.Object
  clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - ANSIBLE_CONNECTION
```
public static final String ANSIBLE_CONNECTION
```
    Connection type to the host. Candidates are local, smart, ssh, paramiko or winrm. The default is smart.
    
    See Also:
    
    AnsibleConstants.AnsibleConnection, Constant Field Values
  - ANSIBLE_HOST
```
public static final String ANSIBLE_HOST
```
    The name of the host to connect to, if different from the alias you wish to give to it.
    
    See Also:
    
    Constant Field Values
  - ANSIBLE_PORT
```
public static final String ANSIBLE_PORT
```
    The ssh port number, if not 22.
    
    See Also:
    
    Constant Field Values
  - ANSIBLE_USER
```
public static final String ANSIBLE_USER
```
    The default ssh user name to use.
    
    See Also:
    
    Constant Field Values
  - ANSIBLE_PASSWORD
```
public static final String ANSIBLE_PASSWORD
```
    The user password to use (this is insecure, we strongly recommend using --ask-pass or SSH keys).
    
    See Also:
    
    Constant Field Values
  - ANSIBLE_SSH_PRIVATE_KEY_FILE
```
public static final String ANSIBLE_SSH_PRIVATE_KEY_FILE
```
    Private key file used by ssh. Useful if using multiple keys and you don't want to use SSH agent.
    
    See Also:
    
    Constant Field Values
  - ANSIBLE_SSH_COMMON_ARGS
```
public static final String ANSIBLE_SSH_COMMON_ARGS
```
    This setting is always appended to the default command line for sftp, scp, and ssh. Useful to configure a ProxyCommand for a certain host (or group).
    
    See Also:
    
    Constant Field Values
  - ANSIBLE_SFTP_EXTRA_ARGS
```
public static final String ANSIBLE_SFTP_EXTRA_ARGS
```
    This setting is always appended to the default sftp command line.
    
    See Also:
    
    Constant Field Values
  - ANSIBLE_SCP_EXTRA_ARGS
```
public static final String ANSIBLE_SCP_EXTRA_ARGS
```
    This setting is always appended to the default scp command line.
    
    See Also:
    
    Constant Field Values
  - ANSIBLE_SSH_EXTRA_ARGS
```
public static final String ANSIBLE_SSH_EXTRA_ARGS
```
    This setting is always appended to the default ssh command line.
    
    See Also:
    
    Constant Field Values
  - ANSIBLE_SSH_PIPELINING
```
public static final String ANSIBLE_SSH_PIPELINING
```
    Determines whether or not to use SSH pipelining. This can override the pipelining setting in ansible.cfg.
    
    See Also:
    
    Constant Field Values
  - ANSIBLE_BECOME
```
public static final String ANSIBLE_BECOME
```
    Equivalent to ansible_sudo or ansible_su, allows to force privilege escalation.
    
    See Also:
    
    Constant Field Values
  - ANSIBLE_BECOME_METHOD
```
public static final String ANSIBLE_BECOME_METHOD
```
    Allows to set privilege escalation method.
    
    See Also:
    
    Constant Field Values
  - ANSIBLE_BECOME_USER
```
public static final String ANSIBLE_BECOME_USER
```
    Equivalent to ansible_sudo_user or ansible_su_user, allows to set the user you become through privilege escalation.
    
    See Also:
    
    Constant Field Values
  - ANSIBLE_BECOME_PASS
```
public static final String ANSIBLE_BECOME_PASS
```
    Equivalent to ansible_sudo_pass or ansible_su_pass, allows you to set the privilege escalation password.
    
    See Also:
    
    Constant Field Values
  - ANSIBLE_SHELL_TYPE
```
public static final String ANSIBLE_SHELL_TYPE
```
    The shell type of the target system. Commands are formatted using 'sh'-style syntax by default. Setting this to csh or fish will cause commands executed on target systems to follow those shell's syntax instead.
    
    See Also:
    
    Constant Field Values
  - ANSIBLE_PYTHON_INTERPRETER
```
public static final String ANSIBLE_PYTHON_INTERPRETER
```
    The target host python path. This is useful for systems with more than one Python or not located at /usr/bin/python such as BSD, or where /usr/bin/python is not a 2.X series Python. We do not use the /usr/bin/env mechanism as that requires the remote user's path to be set right and also assumes the python executable is named python, where the executable might be named something like python26.
    
    See Also:
    
    Constant Field Values
  - ANSIBLE_WINRM_SCHEME
```
public static final String ANSIBLE_WINRM_SCHEME
```
    Specify the connection scheme (http or https) to use for the WinRM connection. Ansible uses https by default unless the port is 5985.
    
    See Also:
    
    AnsibleConstants.AnsibleWinRMScheme, Constant Field Values
  - ANSIBLE_WINRM_PATH
```
public static final String ANSIBLE_WINRM_PATH
```
    Specify an alternate path to the WinRM endpoint. Ansible uses /wsman by default.
    
    See Also:
    
    Constant Field Values
  - ANSIBLE_WINRM_REALM
```
public static final String ANSIBLE_WINRM_REALM
```
    Specify the realm to use for Kerberos authentication. If the username contains "@", Ansible will use the part of the username after "@" by default.
    
    See Also:
    
    Constant Field Values
  - ANSIBLE_WINRM_TRANSPORT
```
public static final String ANSIBLE_WINRM_TRANSPORT
```
    Specify one or more transports as a comma-separated list. By default, Ansible will use kerberos,plaintext if the "kerberos" module is installed and a realm is defined, otherwise plaintext.
    
    See Also:
    
    Constant Field Values
  - ANSIBLE_WINRM_SERVER_CERT_VALIDATION
```
public static final String ANSIBLE_WINRM_SERVER_CERT_VALIDATION
```
    Specify the server certificate validation mode (ignore or validate). Ansible defaults to validate on Python 2.7.9 and higher, which will result in certificate validation errors against the Windows self-signed certificates. Unless verifiable certificates have been configured on the WinRM listeners, this should be set to ignore.
    
    See Also:
    
    Constant Field Values
  - ANSIBLE_WINRM_KERBEROS_DELEGATION
```
public static final String ANSIBLE_WINRM_KERBEROS_DELEGATION
```
    Set to true to enable delegation of commands on the remote host when using kerberos.
    
    See Also:
    
    Constant Field Values
  - ANSIBLE_WINRM_READ_TIMEOUT_SEC
```
public static final String ANSIBLE_WINRM_READ_TIMEOUT_SEC
```
    Maximum seconds to wait before an HTTP connect/read times out (default 30). This value should be slightly higher than operation_timeout_sec, as the server can block *at least* that long.
    
    See Also:
    
    Constant Field Values
  - ANSIBLE_WINRM_OPERATION_TIMEOUT_SEC
```
public static final String ANSIBLE_WINRM_OPERATION_TIMEOUT_SEC
```
    Maximum allowed time in seconds for any single wsman HTTP operation (default 20). Note that operation timeouts while receiving output (the only wsman operation that should take any significant time, and where these timeouts are expected) will be silently retried indefinitely.
    
    See Also:
    
    Constant Field Values
  - ANSIBLE_WINRM_KERBEROS_HOSTNAME_OVERRIDE
```
public static final String ANSIBLE_WINRM_KERBEROS_HOSTNAME_OVERRIDE
```
    The hostname to use for the kerberos exchange (defaults to the hostname in the endpoint URL).
    
    See Also:
    
    Constant Field Values
  - ALL_GROUP
```
public static final String ALL_GROUP
```
    Default group that contains all hosts in the inventory.
    
    See Also:
    
    Constant Field Values

Class AnsibleConstants

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ANSIBLE_CONNECTION

ANSIBLE_HOST

ANSIBLE_PORT

ANSIBLE_USER

ANSIBLE_PASSWORD

ANSIBLE_SSH_PRIVATE_KEY_FILE

ANSIBLE_SSH_COMMON_ARGS

ANSIBLE_SFTP_EXTRA_ARGS

ANSIBLE_SCP_EXTRA_ARGS

ANSIBLE_SSH_EXTRA_ARGS

ANSIBLE_SSH_PIPELINING

ANSIBLE_BECOME

ANSIBLE_BECOME_METHOD

ANSIBLE_BECOME_USER

ANSIBLE_BECOME_PASS

ANSIBLE_SHELL_TYPE

ANSIBLE_PYTHON_INTERPRETER

ANSIBLE_WINRM_SCHEME

ANSIBLE_WINRM_PATH

ANSIBLE_WINRM_REALM

ANSIBLE_WINRM_TRANSPORT

ANSIBLE_WINRM_SERVER_CERT_VALIDATION

ANSIBLE_WINRM_KERBEROS_DELEGATION

ANSIBLE_WINRM_READ_TIMEOUT_SEC

ANSIBLE_WINRM_OPERATION_TIMEOUT_SEC

ANSIBLE_WINRM_KERBEROS_HOSTNAME_OVERRIDE

ALL_GROUP