Inmanta Reference¶
Welcome to the Inmanta reference guide!
Here we explain all the features and options of Inmanta. If you’re just looking to get started with Inmanta, please check out the Quickstart guide.
- Command Reference
- Configuration Reference
- Environment Settings Reference
- Compiler Configuration Reference
- Programmatic API reference
- Constants
- Compiler exceptions
- Plugins
- Resources
- Handlers
cache()
provider()
SkipResource
ResourcePurged
HandlerContext
ResourceHandler
CRUDHandler
CRUDHandler.calculate_diff()
CRUDHandler.can_reload()
CRUDHandler.check_facts()
CRUDHandler.check_resource()
CRUDHandler.close()
CRUDHandler.create_resource()
CRUDHandler.delete_resource()
CRUDHandler.deploy()
CRUDHandler.do_changes()
CRUDHandler.do_reload()
CRUDHandler.execute()
CRUDHandler.facts()
CRUDHandler.get_client()
CRUDHandler.get_file()
CRUDHandler.list_changes()
CRUDHandler.post()
CRUDHandler.pre()
CRUDHandler.read_resource()
CRUDHandler.run_sync()
CRUDHandler.set_cache()
CRUDHandler.stat_file()
CRUDHandler.update_resource()
CRUDHandler.upload_file()
- Export
- Attributes
- Modules
- Project
- Python Environment
- Variables
- Typing
- Protocol
- Data
- Domain conversion
- Rest API
clear_environment()
create_environment()
create_project()
create_token()
delete_environment()
delete_param()
delete_project()
delete_setting()
delete_version()
deploy()
diff()
do_dryrun()
dryrun_list()
dryrun_report()
dryrun_request()
dryrun_update()
get_agent_process()
get_code()
get_compile_queue()
get_environment()
get_file()
get_param()
get_parameter()
get_project()
get_report()
get_reports()
get_resource()
get_resources_for_agent()
get_server_status()
get_setting()
get_state()
get_status()
get_version()
heartbeat()
heartbeat_reply()
ignore_env()
is_compiling()
list_agent_processes()
list_agents()
list_environments()
list_params()
list_projects()
list_settings()
list_versions()
modify_environment()
modify_project()
notify_change()
notify_change_get()
put_version()
release_version()
resource_action_update()
resource_event()
set_param()
set_parameters()
set_setting()
set_state()
stat_file()
stat_files()
trigger()
trigger_agent()
trigger_read_version()
upload_code_batched()
upload_file()
add_user()
agent_action()
all_agents_action()
compile_details()
delete_user()
discovered_resource_create()
discovered_resource_create_batch()
discovered_resources_get()
discovered_resources_get_batch()
dryrun_trigger()
environment_clear()
environment_create()
environment_create_token()
environment_delete()
environment_get()
environment_list()
environment_modify()
environment_setting_delete()
environment_setting_get()
environment_settings_list()
environment_settings_set()
get_agent_process_details()
get_agents()
get_all_facts()
get_api_docs()
get_compile_data()
get_compile_reports()
get_current_user()
get_diff_of_versions()
get_dryrun_diff()
get_environment_metrics()
get_fact()
get_facts()
get_notification()
get_parameters()
get_pip_config()
get_resource_actions()
get_resource_events()
get_resources_in_version()
get_source_code()
halt_environment()
list_desired_state_versions()
list_dryruns()
list_notifications()
list_users()
login()
project_create()
project_delete()
project_get()
project_list()
project_modify()
promote_desired_state_version()
put_partial()
reserve_version()
resource_deploy_done()
resource_deploy_start()
resource_details()
resource_did_dependency_change()
resource_history()
resource_list()
resource_logs()
resources_status()
resume_environment()
set_fact()
set_parameter()
set_password()
update_agent_map()
update_notification()
versioned_resource_details()
- Server
- Inmanta Compile Data Reference
- Inmanta modules
- Modules
- Module ip
- Module net
- Module redhat
- Module ubuntu
- Module user
- apt adapter
- aws adapter
- Usage example
- Module aws
- Changelog
- v4.0.6 - 2024-10-04
- v4.0.5 - 2024-10-03
- v4.0.4 - 2024-07-12
- v4.0.3 - 2024-07-05
- v4.0.2 - 2024-04-09
- v4.0.1 - 2024-03-29
- v4.0.0 - 2023-12-07
- v3.2.13 - 2023-10-12
- v3.2.12 - 2023-06-30
- v3.2.11 - 2023-05-08
- v3.2.10 - 2023-04-04
- v3.2.9 - 2023-04-04
- v3.2.8 - 2023-02-07
- v3.1.12
- v3.1.11
- v3.1.10
- v3.1.7
- v3.1.6
- v3.1.4
- v3.1.3
- v3.0.10
- v3.0.9
- v3.0.8
- v3.0.7
- v3.0.6
- v3.0.5
- v3.0.4
- v3.0.3
- v3.0.2
- v3.0.1
- v3.0.0
- Usage example
- exec adapter
- fs adapter
- Graph module
- Openstack adapter
- How to use it
- Prerequisites
- Creating machines
- Getting the agent on the machine
- Pushing resources to the machine
- Actual usage
- Module openstack
- Typedefs
- Entities
- Implementations
- Plugins
- Resources
- Handlers
openstack.FlavorHandler
openstack.ImageHandler
openstack.VirtualMachineHandler
openstack.NetworkHandler
openstack.RouterHandler
openstack.SubnetHandler
openstack.RouterPortHandler
openstack.HostPortHandler
openstack.SecurityGroupHandler
openstack.FloatingIPHandler
openstack.ProjectHandler
openstack.UserHandler
openstack.RoleHandler
openstack.ServiceHandler
openstack.EndpointHandler
- Changelog
- v4.0.7 - 2024-10-04
- v4.0.6 - 2024-07-12
- v4.0.5 - 2024-07-05
- v4.0.4 - 2024-03-29
- v4.0.3 - 2024-02-14
- v4.0.2 - 2023-12-11
- v4.0.1 - 2023-12-07
- 4.0.0 - 2023-12-07
- v3.8.12 - 2023-10-12
- v3.8.11 - 2023-06-30
- v3.8.10 - 2023-05-08
- v3.8.9 - 2023-04-04
- v3.8.8 - 2023-04-04
- v3.8.7 - 2023-02-02
- v3.8.6 - 2023-02-02
- 3.8.3
- 3.7.11
- 3.7.10
- 3.7.7
- 3.7.5
- 3.7.3
- 3.7.2
- 3.7.1
- 3.7.0
- 3.6.13
- 3.6.12
- 3.6.11
- 3.6.10
- 3.6.9
- 3.6.8
- 3.6.7
- 3.6.6
- 3.6.5
- 3.6.4
- 3.6.3
- 3.6.2
- 3.6.1
- 3.6.0
- 3.5.6
- 3.5.5
- 3.5.4
- 3.5.3
- 3.5.2
- 3.5.1
- 3.5.0
- 3.4.1
- 3.4.0
- 3.3.2
- 3.3.1
- 3.3.0
- 3.2.0
- 3.1.1
- Module openstack
- How to use it
- rest adapter
- ssh adapter
- std module
- Features
- Usage example
- Module std
- Typedefs
- Entities
- Implementations
- Plugins
std.add_to_ip()
std.assert()
std.at()
std.attr()
std.capitalize()
std.contains()
std.count()
std.dict_get()
std.environment()
std.environment_name()
std.environment_server()
std.equals()
std.familyof()
std.file()
std.filter()
std.flatten()
std.generate_password()
std.get_env()
std.get_env_int()
std.getattr()
std.getfact()
std.hostname()
std.inlineif()
std.invert()
std.ip_address_from_interface()
std.ipindex()
std.is_base64_encoded()
std.is_instance()
std.is_unknown()
std.isset()
std.item()
std.key_sort()
std.len()
std.length()
std.limit()
std.list_files()
std.lower()
std.netmask()
std.network_address()
std.objid()
std.password()
std.prefixlen()
std.prefixlength_to_netmask()
std.print()
std.replace()
std.select()
std.sequence()
std.server_ca()
std.server_port()
std.server_ssl()
std.server_token()
std.source()
std.split()
std.template()
std.timestamp()
std.to_number()
std.type()
std.unique()
std.unique_file()
std.upper()
std.validate_type()
- Resources
- Handlers
- Changelog
- v6.1.0 - 2024-10-07
- v6.0.2 - 2024-10-04
- v6.0.1 - 2024-09-25
- v6.0.0 - 2024-08-28
- v5.2.2 - 2024-07-04
- v5.2.1 - 2024-03-29
- v5.2.0 - 2024-03-05
- v5.1.1 - 2024-02-19
- v5.1.0 - 2024-01-16
- v5.0.0 - 2023-12-07
- v4.4.0 - 2023-12-05
- v4.3.5 - 2023-11-21
- v4.3.4 - 2023-11-10
- v4.3.3 - 2023-11-08
- v4.3.2 - 2023-10-27
- v4.3.1 - 2023-10-25
- v4.3.0 - 2023-10-24
- v4.2.1 - 2023-10-05
- v4.2.0 - 2023-09-08
- v4.1.10 - 2023-09-06
- v4.1.9 - 2023-08-31
- v4.1.8 - 2023-06-30
- v4.1.7 - 2023-04-18
- v4.1.6 - 2023-04-04
- v4.1.5 - 2023-03-22
- v4.1.4 - 2023-03-06
- v4.1.3 - 2023-02-02
- v4.1.1 - 2023-01-18
- v4.1.0 - 2023-01-13
- v4.0.1
- v4.0.0
- v3.1.3
- v3.1.2
- v3.1.1
- v3.1.0
- v3.0.16
- v3.0.15
- v3.0.14
- v3.0.12
- v3.0.11
- v3.0.9
- v3.0.8
- v3.0.7
- v3.0.6
- v3.0.4
- v3.0.3
- v3.0.2
- v3.0.1
- v3.0.0
- v2.1.9
- v2.1.8
- v2.1.7
- v2.1.6
- v2.1.5
- v2.1.4
- v2.1.3
- v2.1.2
- v2.1.1
- v2.1.0
- v2.0.7
- v2.0.6
- v2.0.5
- v2.0.4
- v2.0.3
- v2.0.2
- v2.0.1
- v2.0.0
- v1.5.3
- v1.5.2
- v1.5.1
- v1.5.0
- v1.4.1
- v1.4.0
- v1.2.0
- v1.1.0
- v1.0.0
- v0.26.0
- Module std
- systemd adapter
- vyos adapter
- yaml module
- yum adapter
- REST API reference
- Compatibility
- API self-referencing links