Index

A

abstract (pyinfra.api.facts.FactBase attribute) AcceptNewPolicy (class in pyinfra.connectors.sshuserclient.client) activate_host() (pyinfra.api.state.State method) add_callback_handler() (pyinfra.api.state.State method)

add_deploy() (in module pyinfra.api.deploy) add_op() (in module pyinfra.api.operation) allow_agent (pyinfra.connectors.ssh.Meta.DataKeys attribute) append_groups_to_host() (in module pyinfra.connectors.ansible) AskPolicy (class in pyinfra.connectors.sshuserclient.client)

B

BaseConnectorMeta (class in pyinfra.api.connectors)

BaseConnectorMeta.DataKeys (class in pyinfra.api.connectors) BaseStateCallback (class in pyinfra.api.state)

C

cache_key (pyinfra.api.util.get_file_io property) check_can_rsync() (in module pyinfra.connectors.local) (in module pyinfra.connectors.ssh) (pyinfra.api.host.Host method) check_pyinfra_version() (in module pyinfra.api.config) check_require_packages() (in module pyinfra.api.config) close (pyinfra.api.util.get_file_io attribute) combined_output_lines (pyinfra.api.operation.OperationMeta attribute) command (pyinfra.api.facts.FactBase attribute) Config (class in pyinfra.api.config) config (pyinfra.api.state.State attribute) config_file (pyinfra.connectors.ssh.Meta.DataKeys attribute) ConfigDefaults (class in pyinfra.api.config) connect() (in module pyinfra.connectors.chroot) (in module pyinfra.connectors.docker) (in module pyinfra.connectors.dockerssh) (in module pyinfra.connectors.local) (in module pyinfra.connectors.ssh) (in module pyinfra.connectors.winrm) (pyinfra.api.host.Host method) (pyinfra.connectors.sshuserclient.client.SSHClient method) connect_all() (in module pyinfra.api.connect) connect_retries (pyinfra.connectors.ssh.Meta.DataKeys attribute)

connect_retry_max_delay (pyinfra.connectors.ssh.Meta.DataKeys attribute) connect_retry_min_delay (pyinfra.connectors.ssh.Meta.DataKeys attribute) CONNECT_TIMEOUT (pyinfra.api.config.ConfigDefaults attribute) connected (pyinfra.api.host.Host property) ConnectError connection (pyinfra.api.host.Host attribute) connector_data (pyinfra.api.host.Host attribute) container (class in pyinfra.context) container_id (pyinfra.connectors.docker.Meta.DataKeys attribute) ContextManager (class in pyinfra.context) ContextObject (class in pyinfra.context) copy() (pyinfra.api.config.Config method) create_fact() (pyinfra.api.host.Host method) create_host_fact() (in module pyinfra.api.facts) current_deploy_data (pyinfra.api.host.Host attribute) current_deploy_filename (pyinfra.api.state.State attribute) current_deploy_kwargs (pyinfra.api.host.Host attribute) current_deploy_name (pyinfra.api.host.Host attribute) current_exec_filename (pyinfra.api.state.State attribute) current_op_file_number (pyinfra.api.state.State attribute) current_op_global_kwargs (pyinfra.api.host.Host attribute) current_op_hash (pyinfra.api.host.Host attribute) cwd (pyinfra.api.state.State attribute)

D

default() (pyinfra.api.facts.FactBase static method) delete_fact() (pyinfra.api.host.Host method) delete_host_fact() (in module pyinfra.api.facts) deploy() (in module pyinfra.api.deploy) (pyinfra.api.host.Host method) DeployError derive_shorthand() (pyinfra.connectors.sshuserclient.client.SSHClient static method)

dict() (pyinfra.api.host.HostData method) disconnect() (in module pyinfra.connectors.docker) (in module pyinfra.connectors.dockerssh) (pyinfra.api.host.Host method) disconnect_all() (in module pyinfra.api.connect) DOAS (pyinfra.api.config.ConfigDefaults attribute) DOAS_USER (pyinfra.api.config.ConfigDefaults attribute)

E

execute() (pyinfra.api.command.FileDownloadCommand method) (pyinfra.api.command.FileUploadCommand method) (pyinfra.api.command.FunctionCommand method) (pyinfra.api.command.PyinfraCommand method) (pyinfra.api.command.RsyncCommand method) (pyinfra.api.command.StringCommand method)

execute_command_with_sudo_retry() (in module pyinfra.connectors.util) executing_op_hash (pyinfra.api.host.Host attribute) extract_callable_datas() (in module pyinfra.api.host) extract_name_data() (in module pyinfra.api.inventory)

F

fact (pyinfra.api.facts.ShortFactBase attribute) FactBase (class in pyinfra.api.facts) FactNameMeta (class in pyinfra.api.facts) fail_hosts() (pyinfra.api.state.State method) FAIL_PERCENT (pyinfra.api.config.ConfigDefaults attribute) FakeInvoke (class in pyinfra.connectors.sshuserclient.config)

FakeInvokeResult (class in pyinfra.connectors.sshuserclient.config) FileDownloadCommand (class in pyinfra.api.command) FileUploadCommand (class in pyinfra.api.command) format_exception() (in module pyinfra.api.util) forward_agent (pyinfra.connectors.ssh.Meta.DataKeys attribute) FunctionCommand (class in pyinfra.api.command)

G

gateway() (pyinfra.connectors.sshuserclient.client.SSHClient method) generate_env() (in module pyinfra.api.arguments) get() (pyinfra.api.host.HostData method) (pyinfra.context.ContextManager method) get_all_connectors() (in module pyinfra.api.connectors) get_args_kwargs_spec() (in module pyinfra.api.util) get_call_location() (in module pyinfra.api.util) get_caller_frameinfo() (in module pyinfra.api.util) get_current_state() (pyinfra.api.config.Config method) get_data() (pyinfra.api.inventory.Inventory method) get_deploy_data() (pyinfra.api.host.Host method) (pyinfra.api.inventory.Inventory method) get_execution_connector() (in module pyinfra.api.connectors) get_execution_connectors() (in module pyinfra.api.connectors) get_execution_kwarg_keys() (in module pyinfra.api.arguments) get_executor_kwarg_keys() (in module pyinfra.api.arguments) get_fact() (in module pyinfra.api.facts) (pyinfra.api.host.Host method) get_facts() (in module pyinfra.api.facts) get_file() (in module pyinfra.connectors.chroot) (in module pyinfra.connectors.docker) (in module pyinfra.connectors.dockerssh) (in module pyinfra.connectors.local) (in module pyinfra.connectors.ssh) (in module pyinfra.connectors.winrm) (pyinfra.api.host.Host method) get_file_io (class in pyinfra.api.util)

get_file_path() (in module pyinfra.api.util) get_file_sha1() (in module pyinfra.api.util) get_group() (pyinfra.api.inventory.Inventory method) get_group_data() (pyinfra.api.inventory.Inventory method) get_groups_data() (pyinfra.api.inventory.Inventory method) get_host() (pyinfra.api.inventory.Inventory method) get_host_data() (pyinfra.api.inventory.Inventory method) get_host_fact() (in module pyinfra.api.facts) get_host_keys() (in module pyinfra.connectors.sshuserclient.client) get_kwargs_str() (in module pyinfra.api.util) get_masked_value() (pyinfra.api.command.StringCommand method) get_mech_config() (in module pyinfra.connectors.mech) get_mech_options() (in module pyinfra.connectors.mech) get_missing_host_key_policy() (in module pyinfra.connectors.sshuserclient.client) get_op_data() (pyinfra.api.state.State method) get_op_meta() (pyinfra.api.state.State method) get_op_order() (pyinfra.api.state.State method) get_operation_order_from_stack() (in module pyinfra.api.util) get_override_data() (pyinfra.api.inventory.Inventory method) get_path_permissions_mode() (in module pyinfra.api.util) get_raw_value() (pyinfra.api.command.StringCommand method) get_short_facts() (in module pyinfra.api.facts) get_ssh_config() (in module pyinfra.connectors.sshuserclient.client) get_temp_filename() (pyinfra.api.state.State method) get_template() (in module pyinfra.api.util) get_vagrant_config() (in module pyinfra.connectors.vagrant) get_vagrant_options() (in module pyinfra.connectors.vagrant) group_data (pyinfra.api.host.Host property)

H

handles_execution (pyinfra.api.connectors.BaseConnectorMeta attribute) (pyinfra.connectors.chroot.Meta attribute) (pyinfra.connectors.docker.Meta attribute) (pyinfra.connectors.dockerssh.Meta attribute) (pyinfra.connectors.local.Meta attribute) (pyinfra.connectors.ssh.Meta attribute) (pyinfra.connectors.winrm.Meta attribute) Host (class in pyinfra.api.host)

host_before_connect() (pyinfra.api.state.BaseStateCallback static method) host_connect() (pyinfra.api.state.BaseStateCallback static method) host_connect_error() (pyinfra.api.state.BaseStateCallback static method) host_data (pyinfra.api.host.Host property) host_disconnect() (pyinfra.api.state.BaseStateCallback static method) HostData (class in pyinfra.api.host) hostname (pyinfra.connectors.ssh.Meta.DataKeys attribute) (pyinfra.connectors.winrm.Meta.DataKeys attribute)

I

identifier (pyinfra.connectors.docker.Meta.DataKeys attribute) IGNORE_ERRORS (pyinfra.api.config.ConfigDefaults attribute) in_deploy (pyinfra.api.host.Host attribute) in_op (pyinfra.api.host.Host attribute) include() (in module pyinfra.local) init() (pyinfra.api.state.State method) init_base_classes() (in module pyinfra.context) initialised (pyinfra.api.state.State attribute)

Inventory (class in pyinfra.api.inventory) inventory (pyinfra.api.state.State attribute) InventoryError is_executing (pyinfra.api.state.State attribute) is_host_in_limit() (pyinfra.api.state.State method) isset() (pyinfra.context.ContextManager method) iter_activated_hosts() (pyinfra.api.inventory.Inventory method) iter_active_hosts() (pyinfra.api.inventory.Inventory method)

K

key (pyinfra.connectors.ssh.Meta.DataKeys attribute) key_password (pyinfra.connectors.ssh.Meta.DataKeys attribute) keys() (pyinfra.api.connectors.BaseConnectorMeta class method) keys_prefix (pyinfra.api.connectors.BaseConnectorMeta attribute) (pyinfra.connectors.docker.Meta attribute) (pyinfra.connectors.ssh.Meta attribute) (pyinfra.connectors.winrm.Meta attribute)

known_hosts_file (pyinfra.connectors.ssh.Meta.DataKeys attribute)

L

len_activated_hosts() (pyinfra.api.inventory.Inventory method) len_active_hosts() (pyinfra.api.inventory.Inventory method) LocalContextObject (class in pyinfra.context) lock_current_state() (pyinfra.api.config.Config method) log_error_or_warning() (in module pyinfra.api.util)

log_host_command_error() (in module pyinfra.api.util) log_operation_start() (in module pyinfra.api.util) look_for_keys (pyinfra.connectors.ssh.Meta.DataKeys attribute) loop() (pyinfra.api.host.Host method) loop_position (pyinfra.api.host.Host attribute)

M

make_formatted_string_command() (in module pyinfra.api.command) make_hash() (in module pyinfra.api.util) make_hosts_and_groups() (pyinfra.api.inventory.Inventory method) make_names_data() (in module pyinfra.connectors.ansible) (in module pyinfra.connectors.chroot) (in module pyinfra.connectors.docker) (in module pyinfra.connectors.dockerssh) (in module pyinfra.connectors.local) (in module pyinfra.connectors.mech) (in module pyinfra.connectors.ssh) (in module pyinfra.connectors.terraform) (in module pyinfra.connectors.vagrant) (in module pyinfra.connectors.winrm) make_unix_command() (in module pyinfra.connectors.util) make_unix_command_for_host() (in module pyinfra.connectors.util) make_win_command() (in module pyinfra.connectors.util) MaskString (class in pyinfra.api.command) memoize() (in module pyinfra.api.util) Meta (class in pyinfra.connectors.chroot) (class in pyinfra.connectors.docker) (class in pyinfra.connectors.dockerssh) (class in pyinfra.connectors.local) (class in pyinfra.connectors.ssh) (class in pyinfra.connectors.winrm) Meta.DataKeys (class in pyinfra.connectors.docker) (class in pyinfra.connectors.ssh) (class in pyinfra.connectors.winrm) missing_host_key() (pyinfra.connectors.sshuserclient.client.AcceptNewPolicy method) (pyinfra.connectors.sshuserclient.client.AskPolicy method) (pyinfra.connectors.sshuserclient.client.StrictPolicy method) (pyinfra.connectors.sshuserclient.client.WarningPolicy method) module pyinfra.api.arguments pyinfra.api.command pyinfra.api.config pyinfra.api.connect pyinfra.api.connectors pyinfra.api.deploy pyinfra.api.exceptions pyinfra.api.facts pyinfra.api.host pyinfra.api.inventory pyinfra.api.operation pyinfra.api.operations pyinfra.api.state pyinfra.api.util pyinfra.connectors pyinfra.connectors.ansible pyinfra.connectors.chroot pyinfra.connectors.docker pyinfra.connectors.dockerssh pyinfra.connectors.local pyinfra.connectors.mech pyinfra.connectors.pyinfrawinrmsession pyinfra.connectors.ssh pyinfra.connectors.sshuserclient pyinfra.connectors.sshuserclient.client pyinfra.connectors.sshuserclient.config pyinfra.connectors.terraform pyinfra.connectors.util pyinfra.connectors.vagrant pyinfra.connectors.winrm pyinfra.context pyinfra.local pyinfra.progress pyinfra.version

N

name (pyinfra.api.facts.FactBase attribute) (pyinfra.api.facts.ShortFactBase attribute) nested_executing_op_hash (pyinfra.api.host.Host attribute) NoConnectorError

NoGroupError NoHostError NoMoreHostsError noop() (pyinfra.api.host.Host method)

O

ok (pyinfra.connectors.sshuserclient.config.FakeInvokeResult attribute) operation() (in module pyinfra.api.operation) operation_end() (pyinfra.api.state.BaseStateCallback static method) operation_host_error() (pyinfra.api.state.BaseStateCallback static method) operation_host_start() (pyinfra.api.state.BaseStateCallback static method) operation_host_success() (pyinfra.api.state.BaseStateCallback static method)

operation_start() (pyinfra.api.state.BaseStateCallback static method) operation_timeout_sec (pyinfra.connectors.winrm.Meta.DataKeys attribute) OperationError OperationMeta (class in pyinfra.api.operation) OperationTypeError OperationValueError override_datas (pyinfra.api.host.HostData attribute)

P

PARALLEL (pyinfra.api.config.ConfigDefaults attribute) paramiko_connect_kwargs (pyinfra.connectors.ssh.Meta.DataKeys attribute) parse() (pyinfra.connectors.sshuserclient.config.SSHConfig method) parse_config() (pyinfra.connectors.sshuserclient.client.SSHClient method) parse_inventory() (in module pyinfra.connectors.ansible) parse_inventory_ini() (in module pyinfra.connectors.ansible) parse_inventory_tree() (in module pyinfra.connectors.ansible) password (pyinfra.connectors.ssh.Meta.DataKeys attribute) (pyinfra.connectors.winrm.Meta.DataKeys attribute) pool (pyinfra.api.state.State attribute) pop_global_arguments() (in module pyinfra.api.arguments) port (pyinfra.connectors.ssh.Meta.DataKeys attribute) (pyinfra.connectors.winrm.Meta.DataKeys attribute) preserve_loop_order() (pyinfra.api.state.State method) PRESERVE_SU_ENV (pyinfra.api.config.ConfigDefaults attribute) PRESERVE_SUDO_ENV (pyinfra.api.config.ConfigDefaults attribute) print_fact_info (pyinfra.api.state.State attribute) print_fact_input (pyinfra.api.state.State attribute) print_fact_output (pyinfra.api.state.State attribute) print_host_combined_output() (in module pyinfra.api.util) print_input (pyinfra.api.state.State attribute) print_noop_info (pyinfra.api.state.State attribute) print_output (pyinfra.api.state.State attribute) print_prefix (pyinfra.api.host.Host property) process() (pyinfra.api.facts.FactBase static method) process_data() (pyinfra.api.facts.ShortFactBase static method) process_pipeline() (pyinfra.api.facts.FactBase method) progress_spinner() (in module pyinfra.progress) put_file() (in module pyinfra.connectors.chroot) (in module pyinfra.connectors.docker) (in module pyinfra.connectors.dockerssh) (in module pyinfra.connectors.local) (in module pyinfra.connectors.ssh) (in module pyinfra.connectors.winrm) (pyinfra.api.host.Host method) pyinfra.api.arguments module pyinfra.api.command module pyinfra.api.config module pyinfra.api.connect module pyinfra.api.connectors module pyinfra.api.deploy module pyinfra.api.exceptions module pyinfra.api.facts module pyinfra.api.host module

pyinfra.api.inventory module pyinfra.api.operation module pyinfra.api.operations module pyinfra.api.state module pyinfra.api.util module pyinfra.connectors module pyinfra.connectors.ansible module pyinfra.connectors.chroot module pyinfra.connectors.docker module pyinfra.connectors.dockerssh module pyinfra.connectors.local module pyinfra.connectors.mech module pyinfra.connectors.pyinfrawinrmsession module pyinfra.connectors.ssh module pyinfra.connectors.sshuserclient module pyinfra.connectors.sshuserclient.client module pyinfra.connectors.sshuserclient.config module pyinfra.connectors.terraform module pyinfra.connectors.util module pyinfra.connectors.vagrant module pyinfra.connectors.winrm module pyinfra.context module pyinfra.local module pyinfra.progress module pyinfra.version module PyinfraCommand (class in pyinfra.api.command) PyinfraError PyinfraWinrmSession (class in pyinfra.connectors.pyinfrawinrmsession)

Q

QuoteString (class in pyinfra.api.command)

R

read_buffer() (in module pyinfra.connectors.util) read_buffers_into_queue() (in module pyinfra.connectors.util) read_timeout_sec (pyinfra.connectors.winrm.Meta.DataKeys attribute) reload_fact() (pyinfra.api.host.Host method) reload_host_fact() (in module pyinfra.api.facts) remote_remove() (in module pyinfra.connectors.dockerssh) remove_any_sudo_askpass_file() (in module pyinfra.connectors.util) REQUIRE_PACKAGES (pyinfra.api.config.ConfigDefaults attribute) REQUIRE_PYINFRA_VERSION (pyinfra.api.config.ConfigDefaults attribute) requires_command (pyinfra.api.facts.FactBase attribute) reset() (pyinfra.context.ContextManager method) reset_locked_state() (pyinfra.api.config.Config method) rsync() (in module pyinfra.connectors.local) (in module pyinfra.connectors.ssh) (pyinfra.api.host.Host method)

RsyncCommand (class in pyinfra.api.command) run() (pyinfra.connectors.sshuserclient.config.FakeInvoke static method) run_cmd() (pyinfra.connectors.pyinfrawinrmsession.PyinfraWinrmSession method) run_host_op() (in module pyinfra.api.operations) run_local_process() (in module pyinfra.connectors.util) run_ops() (in module pyinfra.api.operations) run_ps() (pyinfra.connectors.pyinfrawinrmsession.PyinfraWinrmSession method) run_shell_command() (in module pyinfra.connectors.chroot) (in module pyinfra.connectors.docker) (in module pyinfra.connectors.dockerssh) (in module pyinfra.connectors.local) (in module pyinfra.connectors.ssh) (in module pyinfra.connectors.winrm) (pyinfra.api.host.Host method)

S

set() (pyinfra.context.ContextManager method) set_base() (pyinfra.context.ContextManager method) set_combined_output_lines() (pyinfra.api.operation.OperationMeta method) set_current_state() (pyinfra.api.config.Config method) set_op_data() (pyinfra.api.state.State method) sha1_hash() (in module pyinfra.api.util) SHELL (pyinfra.api.config.ConfigDefaults attribute) shell() (in module pyinfra.local) shell_executable (pyinfra.api.facts.FactBase attribute) ShortFactBase (class in pyinfra.api.facts) show_legacy_argument_host_data_warning() (in module pyinfra.api.arguments) show_legacy_argument_warning() (in module pyinfra.api.arguments) show_pre_or_post_condition_warning() (in module pyinfra.api.operations) show_state_host_arguments_warning() (in module pyinfra.api.deploy) (in module pyinfra.api.operation) show_warning() (in module pyinfra.connectors.ansible) (in module pyinfra.connectors.chroot) (in module pyinfra.connectors.dockerssh) (in module pyinfra.connectors.terraform) (in module pyinfra.connectors.winrm)

split_combined_output() (in module pyinfra.connectors.util) SSHClient (class in pyinfra.connectors.sshuserclient.client) SSHConfig (class in pyinfra.connectors.sshuserclient.config) State (class in pyinfra.api.state) state (pyinfra.api.host.Host attribute) (pyinfra.api.inventory.Inventory attribute) stderr (pyinfra.api.operation.OperationMeta property) stderr_lines (pyinfra.api.operation.OperationMeta property) stdout (pyinfra.api.operation.OperationMeta property) stdout_lines (pyinfra.api.operation.OperationMeta property) strict_host_key_checking (pyinfra.connectors.ssh.Meta.DataKeys attribute) StrictPolicy (class in pyinfra.connectors.sshuserclient.client) StringCommand (class in pyinfra.api.command) style_print_prefix() (pyinfra.api.host.Host method) SU_SHELL (pyinfra.api.config.ConfigDefaults attribute) SU_USER (pyinfra.api.config.ConfigDefaults attribute) SUDO (pyinfra.api.config.ConfigDefaults attribute) SUDO_USER (pyinfra.api.config.ConfigDefaults attribute)

T

TEMP_DIR (pyinfra.api.config.ConfigDefaults attribute) to_dict() (pyinfra.api.state.State method)

transport (pyinfra.connectors.winrm.Meta.DataKeys attribute) trigger_callbacks() (pyinfra.api.state.State method) try_int() (in module pyinfra.api.util)

U

use() (pyinfra.context.ContextManager method) USE_SU_LOGIN (pyinfra.api.config.ConfigDefaults attribute) USE_SUDO_LOGIN (pyinfra.api.config.ConfigDefaults attribute)

USE_SUDO_PASSWORD (pyinfra.api.config.ConfigDefaults attribute) user (pyinfra.connectors.ssh.Meta.DataKeys attribute) (pyinfra.connectors.winrm.Meta.DataKeys attribute)

W

WarningPolicy (class in pyinfra.connectors.sshuserclient.client)

write_stdin() (in module pyinfra.connectors.util)