options

Documentation

Index

• Constants
• func AnsibleAvoidHostKeyChecking()
• func AnsibleForceColor()
• func AnsibleSetEnv(key, value string)
• type AnsibleConnectionOptions
  • func (o *AnsibleConnectionOptions) GenerateCommandConnectionOptions() ([]string, error)
  • func (o *AnsibleConnectionOptions) String() string
• type AnsiblePrivilegeEscalationOptions
  • func (o *AnsiblePrivilegeEscalationOptions) GenerateCommandPrivilegeEscalationOptions() ([]string, error)
  • func (o *AnsiblePrivilegeEscalationOptions) String() string

Constants

const (

	// AskVaultPasswordFlag ask for vault password
	AskVaultPasswordFlag = "--ask-vault-password"

	// CheckFlag don't make any changes; instead, try to predict some of the changes that may occur
	CheckFlag = "--check"

	// DiffFlag when changing (small) files and templates, show the differences in those files; works great with --check
	DiffFlag = "--diff"

	// ExtraVarsFlag is the extra variables flag for ansible-playbook
	ExtraVarsFlag = "--extra-vars"

	// ForksFlag specify number of parallel processes to use (default=50)
	ForksFlag = "--forks"

	// InventoryFlag is the inventory flag for ansible-playbook
	InventoryFlag = "--inventory"

	// LimitFlag is the limit flag for ansible-playbook
	LimitFlag = "--limit"

	// ListHostsFlag is the list hosts flag for ansible-playbook
	ListHostsFlag = "--list-hosts"

	// ModulePathFlag repend colon-separated path(s) to module library (default=~/.ansible/plugins/modules:/usr/share/ansible/plugins/modules)
	ModulePathFlag = "--module-path"

	// SyntaxCheckFlag is the syntax check flag for ansible-playbook
	SyntaxCheckFlag = "--syntax-check"

	// VaultIDFlag the vault identity to use
	VaultIDFlag = "--vault-id"

	// VaultPasswordFileFlag is the vault password file flag for ansible-playbook
	VaultPasswordFileFlag = "--vault-password-file"

	// VersionFlag show program's version number, config file location, configured module search path, module location, executable location and exit
	VersionFlag = "--version"

	// AskPassFlag is ansble-playbook's ask for connection password flag
	AskPassFlag = "--ask-pass"

	// ConnectionFlag is the connection flag for ansible-playbook
	ConnectionFlag = "--connection"

	// PrivateKeyFlag is the private key file flag for ansible-playbook
	PrivateKeyFlag = "--private-key"

	// SCPExtraArgsFlag specify extra arguments to pass to scp only
	SCPExtraArgsFlag = "--scp-extra-args"

	// SFTPExtraArgsFlag specify extra arguments to pass to sftp only
	SFTPExtraArgsFlag = "--sftp-extra-args"

	// SSHCommonArgsFlag specify common arguments to pass to sftp/scp/ssh
	SSHCommonArgsFlag = "--ssh-common-args"

	// SSHExtraArgsFlag specify extra arguments to pass to ssh only
	SSHExtraArgsFlag = "--ssh-extra-args"

	// TimeoutFlag is the timeout flag for ansible-playbook
	TimeoutFlag = "--timeout"

	// UserFlag is the user flag for ansible-playbook
	UserFlag = "--user"

	// BecomeMethodFlag is ansble-playbook's become method flag
	BecomeMethodFlag = "--become-method"

	// BecomeUserFlag is ansble-playbook's become user flag
	BecomeUserFlag = "--become-user"

	// AskBecomePassFlag is ansble-playbook's ask for become user password flag
	AskBecomePassFlag = "--ask-become-pass"

	// BecomeFlag is ansble-playbook's become flag
	BecomeFlag = "--become"

	// AnsibleForceColorEnv is the environment variable which forces color mode
	AnsibleForceColorEnv = "ANSIBLE_FORCE_COLOR"

	// AnsibleHostKeyCheckingEnv
	AnsibleHostKeyCheckingEnv = "ANSIBLE_HOST_KEY_CHECKING"
)

Functions

func AnsibleAvoidHostKeyChecking

func AnsibleAvoidHostKeyChecking()

AnsibleAvoidHostKeyChecking sets the hosts key checking to false

func AnsibleForceColor

func AnsibleForceColor()

AnsibleForceColor changes to a forced color mode

func AnsibleSetEnv

func AnsibleSetEnv(key, value string)

AnsibleSetEnv set any configuration by environment variables. Check ansible configuration at https://docs.ansible.com/ansible/latest/reference_appendices/config.html

Types

type AnsibleConnectionOptions

type AnsibleConnectionOptions struct {
	// AskPass defines whether user's password should be asked to connect to host
	AskPass bool
	// Connection is the type of connection used by ansible-playbook
	Connection string
	// PrivateKey is the user's private key file used to connect to a host
	PrivateKey string
	// SCPExtraArgs specify extra arguments to pass to scp only
	SCPExtraArgs string
	// SFTPExtraArgs specify extra arguments to pass to sftp only
	SFTPExtraArgs string
	// SSHCommonArgs specify common arguments to pass to sftp/scp/ssh
	SSHCommonArgs string
	// SSHExtraArgs specify extra arguments to pass to ssh only
	SSHExtraArgs string
	// Timeout is the connection timeout on ansible-playbook. Take care because Timeout is defined ad string
	Timeout int
	// User is the user to use to connect to a host
	User string
}

AnsibleConnectionOptions object has those parameters described on `Connections Options` section within ansible-playbook's man page, and which defines how to connect to hosts.

func (*AnsibleConnectionOptions) GenerateCommandConnectionOptions

func (o *AnsibleConnectionOptions) GenerateCommandConnectionOptions() ([]string, error)

GenerateCommandConnectionOptions return a list of connection options flags to be used on ansible-playbook execution

func (*AnsibleConnectionOptions) String

func (o *AnsibleConnectionOptions) String() string

String return a list of connection options flags to be used on ansible-playbook execution

type AnsiblePrivilegeEscalationOptions

type AnsiblePrivilegeEscalationOptions struct {
	// AskBecomePass
	AskBecomePass bool
	// Become
	Become bool
	// BecomeMethod
	BecomeMethod string
	// BecomeUser
	BecomeUser string
}

AnsiblePrivilegeEscalationOptions object has those parameters described on `Privilege Escalation Options` section within ansible-playbook's man page, and which controls how and which user you become as on target hosts.

func (*AnsiblePrivilegeEscalationOptions) GenerateCommandPrivilegeEscalationOptions

func (o *AnsiblePrivilegeEscalationOptions) GenerateCommandPrivilegeEscalationOptions() ([]string, error)

GenerateCommandPrivilegeEscalationOptions return a list of privilege escalation options flags to be used on ansible-playbook execution

func (*AnsiblePrivilegeEscalationOptions) String

func (o *AnsiblePrivilegeEscalationOptions) String() string

String return an string