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
- inmanta
- inmanta-cli
- Configuration Reference
- Environment Settings Reference
- Compiler Configuration Reference
- Programmatic API reference
- Constants
- Compiler exceptions
- Plugins
- Resources
- Handlers
cache()provider()SkipResourceResourcePurgedHandlerContextResourceHandlerResourceHandler._diff()ResourceHandler.available()ResourceHandler.can_reload()ResourceHandler.check_facts()ResourceHandler.check_resource()ResourceHandler.close()ResourceHandler.deploy()ResourceHandler.do_changes()ResourceHandler.do_reload()ResourceHandler.execute()ResourceHandler.facts()ResourceHandler.get_client()ResourceHandler.get_file()ResourceHandler.list_changes()ResourceHandler.post()ResourceHandler.pre()ResourceHandler.run_sync()ResourceHandler.set_cache()ResourceHandler.stat_file()ResourceHandler.upload_file()
CRUDHandlerCRUDHandler.available()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()
LocalIOLocalIO.chmod()LocalIO.chown()LocalIO.close()LocalIO.file_exists()LocalIO.file_stat()LocalIO.hash_file()LocalIO.is_remote()LocalIO.is_symlink()LocalIO.mkdir()LocalIO.put()LocalIO.read()LocalIO.read_binary()LocalIO.readlink()LocalIO.remove()LocalIO.rmdir()LocalIO.run()LocalIO.symlink()
- Export
- Attributes
- Modules
- Project
- Python Environment
- Variables
- Typing
- Protocol
- Data
- Domain conversion
- Rest API
clear_environment()create_environment()create_project()create_token()decomission_environment()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()upload_code_batched()upload_file()add_user()agent_action()all_agents_action()compile_details()delete_user()dryrun_trigger()environment_clear()environment_create()environment_create_token()environment_decommission()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_diff_of_versions()get_dryrun_diff()get_environment_metrics()get_fact()get_facts()get_notification()get_parameters()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()resume_environment()set_password()update_agent_map()update_notification()versioned_resource_details()
- Server
- Inmanta Compile Data Reference
- Inmanta modules
- Module ip
- Module lsm
- Module net
- 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.ipindex()std.is_base64_encoded()std.is_instance()std.is_unknown()std.isset()std.item()std.key_sort()std.len()std.length()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
- REST API reference
- Compatibility
- API self-referencing links