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()SkipResourceResourcePurgedHandlerContextResourceHandlerCRUDHandlerCRUDHandler.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()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()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
- Module aci
- Typedefs
- Entities
- Implementations
- Plugins
- Resources
aci.resources.StandaloneResourceaci.resources.RelativeResourceaci.resources.RelativeResourceaci.resources.RelativeResourceaci.resources.RelativeResourceaci.resources.RelativeResourceaci.resources.RelativeResourceaci.resources.RelativeResourceaci.resources.RelativeResourceaci.resources.RelativeResourceaci.resources.RelativeResourceaci.resources.RelativeResourceaci.resources.RelativeResourceaci.resources.RelativeResourceaci.resources.RelativeResourceaci.resources.RelativeResource
- Handlers
aci.resources.StandaloneProvideraci.resources.RelativeProvideraci.resources.RelativeProvideraci.resources.RelativeProvideraci.resources.RelativeProvideraci.resources.RelativeProvideraci.resources.RelativeProvideraci.resources.RelativeProvideraci.resources.RelativeProvideraci.resources.RelativeProvideraci.resources.RelativeProvideraci.resources.RelativeProvideraci.resources.RelativeProvideraci.resources.RelativeProvideraci.resources.RelativeProvideraci.resources.RelativeProvider
- Module aws_dc
- Module azure_expressroute
- Module checkpoint
- Typedefs
- Entities
- Implementations
- Plugins
- Resources
checkpoint.CommonServicecheckpoint.Groupcheckpoint.Hostcheckpoint.ICMPServicecheckpoint.Interfacecheckpoint.Networkcheckpoint.PolicyInstallcheckpoint.PolicyInstallV2checkpoint.PolicyInstallV3checkpoint.Routecheckpoint.Rulecheckpoint.RunScriptcheckpoint.SharedGroupcheckpoint.SharedGroupSubResource
- Handlers
checkpoint.RunScriptHandlercheckpoint.InterfaceHandlercheckpoint.RouteHandlercheckpoint.PolicyInstallHandlercheckpoint.PolicyInstallV2Handlercheckpoint.PolicyInstallV3Handlercheckpoint.SharedGroupHandlercheckpoint.SharedGroupHandlercheckpoint.CheckpointObjectHandlercheckpoint.CheckpointObjectHandlercheckpoint.CheckpointObjectHandlercheckpoint.CheckpointObjectHandlercheckpoint.CheckpointObjectHandlercheckpoint.CheckpointObjectHandler
- Module cisco_xe
- Module cisco_xr
- Module config
- Typedefs
- Plugins
config.absolute_path()config.get_config_template_value()config.get_config_template_value_as_bool()config.get_config_template_value_as_int()config.get_config_template_value_as_number()config.get_config_template_value_as_string()config.get_config_value()config.get_config_value_as_bool()config.get_config_value_as_int()config.get_config_value_as_number()config.get_config_value_as_string()config.get_const()config.get_template_value()config.get_template_value_as_bool()config.get_template_value_as_float()config.get_template_value_as_int()config.get_template_value_as_string()config.resolve_path()
- Module ecx_l2
- Module fnt
- Typedefs
- Entities
- Implementations
- Resources
fnt.resources.entity.EntityResourcefnt.resources.publish_planning_protocol.PublishPlanningProtocolResourcefnt.resources.service.ServiceResourcefnt.resources.generated_entity.CVlanResourcefnt.resources.generated_entity.CellResourcefnt.resources.generated_entity.ChassisInCabinetResourcefnt.resources.generated_entity.LogicalPortSupportType1Resourcefnt.resources.generated_entity.LogicalPortSupportType2Resourcefnt.resources.generated_entity.LogicalPortSupportType3Resourcefnt.resources.generated_entity.NetworkFunctionResourcefnt.resources.generated_entity.SVlanResourcefnt.resources.generated_entity.ServerInCabinetResourcefnt.resources.generated_entity.ServiceAssetResourcefnt.resources.generated_entity.ServiceSamResourcefnt.resources.generated_entity.ServiceTelcoPathResourcefnt.resources.generated_entity.ServiceTelcoPathPacketDataResourcefnt.resources.generated_entity.ServiceTelcoUnroutedPathResourcefnt.resources.generated_entity.VirtualServerResourcefnt.resources.generated_entity.VlanPoolResource
- Handlers
fnt.resources.entity.EntityHandlerfnt.resources.service.ServiceHandlerfnt.resources.generated_entity.GeneratedEntityHandlerfnt.resources.generated_entity.GeneratedEntityHandlerfnt.resources.generated_entity.GeneratedEntityHandlerfnt.resources.generated_entity.GeneratedEntityHandlerfnt.resources.generated_entity.GeneratedEntityHandlerfnt.resources.generated_entity.GeneratedEntityHandlerfnt.resources.generated_entity.GeneratedEntityHandlerfnt.resources.generated_entity.GeneratedEntityHandlerfnt.resources.generated_entity.GeneratedEntityHandlerfnt.resources.generated_entity.GeneratedEntityHandlerfnt.resources.generated_entity.GeneratedEntityHandlerfnt.resources.generated_entity.GeneratedEntityHandlerfnt.resources.generated_entity.GeneratedEntityHandlerfnt.resources.generated_entity.GeneratedEntityHandlerfnt.resources.generated_entity.GeneratedServiceEntityHandlerfnt.resources.generated_entity.GeneratedServiceEntityHandlerfnt.resources.publish_planning_protocol.PublishPlanningProtocolHandler
- Module fortigate
- Typedefs
- Entities
- Implementations
- Resources
fortigate.resources.firewall.address.AddressResourcefortigate.resources.firewall.address6.Address6Resourcefortigate.resources.firewall.addrgrp.AddressGroupResourcefortigate.resources.firewall.addrgrp6.AddressGroup6Resourcefortigate.resources.router.bgp.BGPResourcefortigate.resources.firewall.dos_policy.DosPolicyResourcefortigate.resources.firewall.dos_policy6.DosPolicy6Resourcefortigate.resources.system.interface.InterfaceResourcefortigate.resources.vpn.ipsec_phase1_interface.IpSecPhase1InterfaceResourcefortigate.resources.vpn.ipsec_phase2_interface.IpSecPhase2InterfaceResourcefortigate.resources.system.license.LicenceResourcefortigate.resources.firewall.local_in_policy.LocalInPolicyResourcefortigate.resources.firewall.local_in_policy6.LocalInPolicy6Resourcefortigate.resources.firewall.multicast_policy.MulticastPolicyResourcefortigate.resources.firewall.multicast_policy6.MulticastPolicy6Resourcefortigate.resources.firewall.policy.PolicyResourcefortigate.resources.router.prefix_list.PrefixListResourcefortigate.resources.system.sdwan.SDWanResourcefortigate.resources.system.settings.SettingsResourcefortigate.resources.firewall.shaping_policy.ShapingPolicyResourcefortigate.resources.router.static_route.StaticResourcefortigate.resources.router.static_route6.Static6Resourcefortigate.resources.system.admin.SystemAdminResourcefortigate.resources.system.vdom.VdomResourcefortigate.resources.system.vdom_link.VdomLinkResourcefortigate.resources.firewall.dos_policy_range.DosPolicy6RangeResourcefortigate.resources.firewall.dos_policy_range.DosPolicyRangeResourcefortigate.resources.firewall.local_in_policy_range.LocalInPolicy6RangeResourcefortigate.resources.firewall.local_in_policy_range.LocalInPolicyRangeResourcefortigate.resources.firewall.multicast_policy_range.MulticastPolicy6RangeResourcefortigate.resources.firewall.multicast_policy_range.MulticastPolicyRangeResourcefortigate.resources.firewall.policy_range.PolicyRangeResourcefortigate.resources.firewall.shaping_policy_range.ShapingPolicyRangeResourcefortigate.resources.router.static_route_range.Static6RangeResourcefortigate.resources.router.static_route_range.StaticRangeResourcefortigate.resources.fortiflex.entitlements.EntitlementResourcefortigate.resources.fortiflex.configuration.FortiGateConfigurationResourcefortigate.resources.fortiflex.configuration.FortiManagerConfigurationResource
- Handlers
fortigate.resources.firewall.address.AddressHandlerfortigate.resources.firewall.address6.Address6Handlerfortigate.resources.firewall.addrgrp.AddressGroupHandlerfortigate.resources.firewall.addrgrp6.AddressGroup6Handlerfortigate.resources.firewall.dos_policy.DosPolicyHandlerfortigate.resources.firewall.dos_policy6.DosPolicy6Handlerfortigate.resources.firewall.local_in_policy.LocalInPolicyHandlerfortigate.resources.firewall.local_in_policy6.LocalInPolicy6Handlerfortigate.resources.firewall.multicast_policy.MulticastPolicyHandlerfortigate.resources.firewall.multicast_policy6.MulticastPolicy6Handlerfortigate.resources.firewall.policy.PolicyHandlerfortigate.resources.firewall.shaping_policy.ShapingPolicyHandlerfortigate.resources.router.bgp.BGPHandlerfortigate.resources.router.prefix_list.PrefixListHandlerfortigate.resources.router.static_route.StaticHandlerfortigate.resources.router.static_route6.Static6Handlerfortigate.resources.system.admin.SystemAdminHandlerfortigate.resources.system.interface.InterfaceHandlerfortigate.resources.system.license.LicenceHandlerfortigate.resources.system.sdwan.SDWanHandlerfortigate.resources.system.settings.SettingsHandlerfortigate.resources.system.vdom.VdomHandlerfortigate.resources.system.vdom_link.VdomLinkHandlerfortigate.resources.vpn.ipsec_phase1_interface.IpSecPhase1InterfaceHandlerfortigate.resources.vpn.ipsec_phase2_interface.IpSecPhase2InterfaceHandlerfortigate.resources.fortiflex.configuration.FlexConfigurationHandlerfortigate.resources.fortiflex.configuration.FlexConfigurationHandlerfortigate.resources.fortiflex.entitlements.EntitlementHandlerfortigate.resources.firewall.policy_range.PolicyRangeRangeHandlerfortigate.resources.firewall.policy_range.PolicyRangeRangeHandlerfortigate.resources.firewall.policy_range.PolicyRangeRangeHandlerfortigate.resources.firewall.policy_range.PolicyRangeRangeHandlerfortigate.resources.firewall.policy_range.PolicyRangeRangeHandlerfortigate.resources.firewall.policy_range.PolicyRangeRangeHandlerfortigate.resources.firewall.local_in_policy_range.LocalInPolicyRangeHandlerfortigate.resources.firewall.local_in_policy_range.LocalInPolicyRangeHandlerfortigate.resources.router.static_route_range.StaticRangeHandlerfortigate.resources.router.static_route_range.StaticRangeHandler
- Module gcp_interco
- Module ip
- Module lsm
- Module n5k_lan
- Module netbox
- Typedefs
- Entities
- Implementations
- Plugins
- Resources
netbox.resources.PrimaryIPResourcenetbox.resources.ClusterResourcenetbox.resources.ClusterGroupResourcenetbox.resources.ClusterTypeResourcenetbox.resources.CustomFieldResourcenetbox.resources.DeviceResourcenetbox.resources.DeviceRoleResourcenetbox.resources.DeviceTypeResourcenetbox.resources.IPAddressResourcenetbox.resources.InterfaceResourcenetbox.resources.InterfaceCableResourcenetbox.resources.L2VPNResourcenetbox.resources.L2VPNTerminationResourcenetbox.resources.ManufacturerResourcenetbox.resources.PrefixResourcenetbox.resources.RackResourcenetbox.resources.SiteResourcenetbox.resources.TenantResourcenetbox.resources.TenantGroupResourcenetbox.resources.VMInterfaceResourcenetbox.resources.VRFResourcenetbox.resources.VirtualMachineResourcenetbox.resources.VlanResourcenetbox.resources.VlanGroupResource
- Handlers
netbox.resources.BaseNetboxHandlernetbox.resources.BaseNetboxHandlernetbox.resources.BaseNetboxHandlernetbox.resources.BaseNetboxHandlernetbox.resources.BaseNetboxHandlernetbox.resources.BaseNetboxHandlernetbox.resources.BaseNetboxHandlernetbox.resources.BaseNetboxHandlernetbox.resources.BaseNetboxHandlernetbox.resources.BaseNetboxHandlernetbox.resources.BaseNetboxHandlernetbox.resources.BaseNetboxHandlernetbox.resources.BaseNetboxHandlernetbox.resources.BaseNetboxHandlernetbox.resources.BaseNetboxHandlernetbox.resources.BaseNetboxHandlernetbox.resources.BaseNetboxHandlernetbox.resources.BaseNetboxHandlernetbox.resources.BaseNetboxHandlernetbox.resources.BaseNetboxHandlernetbox.resources.SecretBaseNetboxHandlernetbox.resources.SecretBaseNetboxHandlernetbox.resources.InterfaceCableHandlernetbox.resources.PrimaryIPHandler
- Module nokia_srlinux
- Module nokia_sros
- Module oci_fastconnect
- 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
- Module vcenter
- Typedefs
- Entities
- Implementations
- Plugins
- Resources
vcenter.resource.iso.CreateISOResourcevcenter.resource.distributed_virtual_portgroup.DistributedVirtualPortgroupvcenter.resource.virtual_machine.ESXIVirtualMachineFromOvavcenter.resource.host_dnsconfig.HostDnsConfigvcenter.resource.host_group.HostGroupvcenter.resource.host_portgroup.HostPortgroupvcenter.resource.host_vnic.HostVirtualNicvcenter.resource.host_vswitch.HostVirtualSwitchvcenter.resource.virtual_machine.RenameVirtualMachineResourcevcenter.resource.vmdk_storage_rule.VMDKStorageRulevcenter.unmanaged.VirtualMachineDiscoveryvcenter.resource.virtual_disk.VirtualDiskvcenter.resource.virtual_machine.VirtualMachineFromContentLibraryvcenter.resource.virtual_machine.VcenterVirtualMachineFromOvavcenter.resource.virtual_machine.VcenterVirtualMachineFromTemplatevcenter.resource.virtual_machine_group.VirtualMachineGroupvcenter.resource.virtual_machine_storage_rule.VirtualMachineStorageRulevcenter.resource.virtual_machine_to_host_rule.VirtualMachineToHostRulevcenter.resource.virtual_machine_to_virtual_machine_rule.VirtualMachineToVirtualMachineRule
- Handlers
vcenter.handler.virtual_machine.RenameVirtualMachineHandlervcenter.handler.virtual_machine.VcenterVirtualMachineFromTemplateHandlervcenter.handler.virtual_machine.VcenterVirtualMachineFromOvaHandlervcenter.handler.virtual_machine.ESXIVirtualMachineFromOvaHandlervcenter.handler.virtual_machine.VcenterVirtualMachineFromContentLibraryvcenter.unmanaged.VirtualMachineDiscoveryHandlervcenter.handler.distributed_virtual_portgroup.PortGroupHandlervcenter.handler.host_dnsconfig.HostDnsConfigHandlervcenter.handler.host_group.HostGroupHandlervcenter.handler.host_portgroup.HostPortGroupHandlervcenter.handler.host_vnic.HostVirtualNicHandlervcenter.handler.host_vswitch.HostVirtualSwitchHandlervcenter.handler.iso.CreateISOHandlervcenter.handler.virtual_disk.VirtualDiskHandlervcenter.handler.virtual_machine_group.VirtualMachineGroupHandlervcenter.handler.virtual_machine_storage_rule.VirtualMachineStorageRuleHandlervcenter.handler.virtual_machine_to_host_rule.VirtualMachineToHostRuleHandlervcenter.handler.virtual_machine_to_virtual_machine_rule.VirtualMachineToVirtualMachineRuleHandlervcenter.handler.vmdk_storage_rule.VMDKStorageRuleHandler
- Module aci
- REST API reference
- Compatibility
- API self-referencing links