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()
SkipResource
ResourcePurged
HandlerContext
ResourceHandler
CRUDHandler
CRUDHandler.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()
LocalIO
LocalIO.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.StandaloneResource
aci.resources.RelativeResource
aci.resources.RelativeResource
aci.resources.RelativeResource
aci.resources.RelativeResource
aci.resources.RelativeResource
aci.resources.RelativeResource
aci.resources.RelativeResource
aci.resources.RelativeResource
aci.resources.RelativeResource
aci.resources.RelativeResource
aci.resources.RelativeResource
aci.resources.RelativeResource
aci.resources.RelativeResource
aci.resources.RelativeResource
aci.resources.RelativeResource
- Handlers
aci.resources.StandaloneProvider
aci.resources.RelativeProvider
aci.resources.RelativeProvider
aci.resources.RelativeProvider
aci.resources.RelativeProvider
aci.resources.RelativeProvider
aci.resources.RelativeProvider
aci.resources.RelativeProvider
aci.resources.RelativeProvider
aci.resources.RelativeProvider
aci.resources.RelativeProvider
aci.resources.RelativeProvider
aci.resources.RelativeProvider
aci.resources.RelativeProvider
aci.resources.RelativeProvider
aci.resources.RelativeProvider
- Module aws_dc
- Module azure_expressroute
- Module checkpoint
- Typedefs
- Entities
- Implementations
- Plugins
- Resources
checkpoint.CommonService
checkpoint.Group
checkpoint.Host
checkpoint.ICMPService
checkpoint.Interface
checkpoint.Network
checkpoint.PolicyInstall
checkpoint.PolicyInstallV2
checkpoint.PolicyInstallV3
checkpoint.Route
checkpoint.Rule
checkpoint.RunScript
checkpoint.SharedGroup
checkpoint.SharedGroupSubResource
- Handlers
checkpoint.RunScriptHandler
checkpoint.InterfaceHandler
checkpoint.RouteHandler
checkpoint.PolicyInstallHandler
checkpoint.PolicyInstallV2Handler
checkpoint.PolicyInstallV3Handler
checkpoint.SharedGroupHandler
checkpoint.SharedGroupHandler
checkpoint.CheckpointObjectHandler
checkpoint.CheckpointObjectHandler
checkpoint.CheckpointObjectHandler
checkpoint.CheckpointObjectHandler
checkpoint.CheckpointObjectHandler
checkpoint.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.EntityResource
fnt.resources.publish_planning_protocol.PublishPlanningProtocolResource
fnt.resources.service.ServiceResource
fnt.resources.generated_entity.CVlanResource
fnt.resources.generated_entity.CellResource
fnt.resources.generated_entity.ChassisInCabinetResource
fnt.resources.generated_entity.LogicalPortSupportType1Resource
fnt.resources.generated_entity.LogicalPortSupportType2Resource
fnt.resources.generated_entity.LogicalPortSupportType3Resource
fnt.resources.generated_entity.NetworkFunctionResource
fnt.resources.generated_entity.SVlanResource
fnt.resources.generated_entity.ServerInCabinetResource
fnt.resources.generated_entity.ServiceAssetResource
fnt.resources.generated_entity.ServiceSamResource
fnt.resources.generated_entity.ServiceTelcoPathResource
fnt.resources.generated_entity.ServiceTelcoPathPacketDataResource
fnt.resources.generated_entity.ServiceTelcoUnroutedPathResource
fnt.resources.generated_entity.VirtualServerResource
fnt.resources.generated_entity.VlanPoolResource
- Handlers
fnt.resources.entity.EntityHandler
fnt.resources.service.ServiceHandler
fnt.resources.generated_entity.GeneratedEntityHandler
fnt.resources.generated_entity.GeneratedEntityHandler
fnt.resources.generated_entity.GeneratedEntityHandler
fnt.resources.generated_entity.GeneratedEntityHandler
fnt.resources.generated_entity.GeneratedEntityHandler
fnt.resources.generated_entity.GeneratedEntityHandler
fnt.resources.generated_entity.GeneratedEntityHandler
fnt.resources.generated_entity.GeneratedEntityHandler
fnt.resources.generated_entity.GeneratedEntityHandler
fnt.resources.generated_entity.GeneratedEntityHandler
fnt.resources.generated_entity.GeneratedEntityHandler
fnt.resources.generated_entity.GeneratedEntityHandler
fnt.resources.generated_entity.GeneratedEntityHandler
fnt.resources.generated_entity.GeneratedEntityHandler
fnt.resources.generated_entity.GeneratedServiceEntityHandler
fnt.resources.generated_entity.GeneratedServiceEntityHandler
fnt.resources.publish_planning_protocol.PublishPlanningProtocolHandler
- Module fortigate
- Typedefs
- Entities
- Implementations
- Resources
fortigate.resources.firewall.address.AddressResource
fortigate.resources.firewall.address6.Address6Resource
fortigate.resources.firewall.addrgrp.AddressGroupResource
fortigate.resources.firewall.addrgrp6.AddressGroup6Resource
fortigate.resources.router.bgp.BGPResource
fortigate.resources.firewall.dos_policy.DosPolicyResource
fortigate.resources.firewall.dos_policy6.DosPolicy6Resource
fortigate.resources.system.interface.InterfaceResource
fortigate.resources.vpn.ipsec_phase1_interface.IpSecPhase1InterfaceResource
fortigate.resources.vpn.ipsec_phase2_interface.IpSecPhase2InterfaceResource
fortigate.resources.system.license.LicenceResource
fortigate.resources.firewall.local_in_policy.LocalInPolicyResource
fortigate.resources.firewall.local_in_policy6.LocalInPolicy6Resource
fortigate.resources.firewall.multicast_policy.MulticastPolicyResource
fortigate.resources.firewall.multicast_policy6.MulticastPolicy6Resource
fortigate.resources.firewall.policy.PolicyResource
fortigate.resources.router.prefix_list.PrefixListResource
fortigate.resources.system.sdwan.SDWanResource
fortigate.resources.system.settings.SettingsResource
fortigate.resources.firewall.shaping_policy.ShapingPolicyResource
fortigate.resources.router.static_route.StaticResource
fortigate.resources.router.static_route6.Static6Resource
fortigate.resources.system.admin.SystemAdminResource
fortigate.resources.system.vdom.VdomResource
fortigate.resources.system.vdom_link.VdomLinkResource
fortigate.resources.firewall.dos_policy_range.DosPolicy6RangeResource
fortigate.resources.firewall.dos_policy_range.DosPolicyRangeResource
fortigate.resources.firewall.local_in_policy_range.LocalInPolicy6RangeResource
fortigate.resources.firewall.local_in_policy_range.LocalInPolicyRangeResource
fortigate.resources.firewall.multicast_policy_range.MulticastPolicy6RangeResource
fortigate.resources.firewall.multicast_policy_range.MulticastPolicyRangeResource
fortigate.resources.firewall.policy_range.PolicyRangeResource
fortigate.resources.firewall.shaping_policy_range.ShapingPolicyRangeResource
fortigate.resources.router.static_route_range.Static6RangeResource
fortigate.resources.router.static_route_range.StaticRangeResource
fortigate.resources.fortiflex.entitlements.EntitlementResource
fortigate.resources.fortiflex.configuration.FortiGateConfigurationResource
fortigate.resources.fortiflex.configuration.FortiManagerConfigurationResource
- Handlers
fortigate.resources.firewall.address.AddressHandler
fortigate.resources.firewall.address6.Address6Handler
fortigate.resources.firewall.addrgrp.AddressGroupHandler
fortigate.resources.firewall.addrgrp6.AddressGroup6Handler
fortigate.resources.firewall.dos_policy.DosPolicyHandler
fortigate.resources.firewall.dos_policy6.DosPolicy6Handler
fortigate.resources.firewall.local_in_policy.LocalInPolicyHandler
fortigate.resources.firewall.local_in_policy6.LocalInPolicy6Handler
fortigate.resources.firewall.multicast_policy.MulticastPolicyHandler
fortigate.resources.firewall.multicast_policy6.MulticastPolicy6Handler
fortigate.resources.firewall.policy.PolicyHandler
fortigate.resources.firewall.shaping_policy.ShapingPolicyHandler
fortigate.resources.router.bgp.BGPHandler
fortigate.resources.router.prefix_list.PrefixListHandler
fortigate.resources.router.static_route.StaticHandler
fortigate.resources.router.static_route6.Static6Handler
fortigate.resources.system.admin.SystemAdminHandler
fortigate.resources.system.interface.InterfaceHandler
fortigate.resources.system.license.LicenceHandler
fortigate.resources.system.sdwan.SDWanHandler
fortigate.resources.system.settings.SettingsHandler
fortigate.resources.system.vdom.VdomHandler
fortigate.resources.system.vdom_link.VdomLinkHandler
fortigate.resources.vpn.ipsec_phase1_interface.IpSecPhase1InterfaceHandler
fortigate.resources.vpn.ipsec_phase2_interface.IpSecPhase2InterfaceHandler
fortigate.resources.fortiflex.configuration.FlexConfigurationHandler
fortigate.resources.fortiflex.configuration.FlexConfigurationHandler
fortigate.resources.fortiflex.entitlements.EntitlementHandler
fortigate.resources.firewall.policy_range.PolicyRangeRangeHandler
fortigate.resources.firewall.policy_range.PolicyRangeRangeHandler
fortigate.resources.firewall.policy_range.PolicyRangeRangeHandler
fortigate.resources.firewall.policy_range.PolicyRangeRangeHandler
fortigate.resources.firewall.policy_range.PolicyRangeRangeHandler
fortigate.resources.firewall.policy_range.PolicyRangeRangeHandler
fortigate.resources.firewall.local_in_policy_range.LocalInPolicyRangeHandler
fortigate.resources.firewall.local_in_policy_range.LocalInPolicyRangeHandler
fortigate.resources.router.static_route_range.StaticRangeHandler
fortigate.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.PrimaryIPResource
netbox.resources.ClusterResource
netbox.resources.ClusterGroupResource
netbox.resources.ClusterTypeResource
netbox.resources.CustomFieldResource
netbox.resources.DeviceResource
netbox.resources.DeviceRoleResource
netbox.resources.DeviceTypeResource
netbox.resources.IPAddressResource
netbox.resources.InterfaceResource
netbox.resources.InterfaceCableResource
netbox.resources.L2VPNResource
netbox.resources.L2VPNTerminationResource
netbox.resources.ManufacturerResource
netbox.resources.PrefixResource
netbox.resources.RackResource
netbox.resources.SiteResource
netbox.resources.TenantResource
netbox.resources.TenantGroupResource
netbox.resources.VMInterfaceResource
netbox.resources.VRFResource
netbox.resources.VirtualMachineResource
netbox.resources.VlanResource
netbox.resources.VlanGroupResource
- Handlers
netbox.resources.BaseNetboxHandler
netbox.resources.BaseNetboxHandler
netbox.resources.BaseNetboxHandler
netbox.resources.BaseNetboxHandler
netbox.resources.BaseNetboxHandler
netbox.resources.BaseNetboxHandler
netbox.resources.BaseNetboxHandler
netbox.resources.BaseNetboxHandler
netbox.resources.BaseNetboxHandler
netbox.resources.BaseNetboxHandler
netbox.resources.BaseNetboxHandler
netbox.resources.BaseNetboxHandler
netbox.resources.BaseNetboxHandler
netbox.resources.BaseNetboxHandler
netbox.resources.BaseNetboxHandler
netbox.resources.BaseNetboxHandler
netbox.resources.BaseNetboxHandler
netbox.resources.BaseNetboxHandler
netbox.resources.BaseNetboxHandler
netbox.resources.BaseNetboxHandler
netbox.resources.SecretBaseNetboxHandler
netbox.resources.SecretBaseNetboxHandler
netbox.resources.InterfaceCableHandler
netbox.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.CreateISOResource
vcenter.resource.distributed_virtual_portgroup.DistributedVirtualPortgroup
vcenter.resource.virtual_machine.ESXIVirtualMachineFromOva
vcenter.resource.host_dnsconfig.HostDnsConfig
vcenter.resource.host_group.HostGroup
vcenter.resource.host_portgroup.HostPortgroup
vcenter.resource.host_vnic.HostVirtualNic
vcenter.resource.host_vswitch.HostVirtualSwitch
vcenter.resource.virtual_machine.RenameVirtualMachineResource
vcenter.resource.vmdk_storage_rule.VMDKStorageRule
vcenter.unmanaged.VirtualMachineDiscovery
vcenter.resource.virtual_disk.VirtualDisk
vcenter.resource.virtual_machine.VirtualMachineFromContentLibrary
vcenter.resource.virtual_machine.VcenterVirtualMachineFromOva
vcenter.resource.virtual_machine.VcenterVirtualMachineFromTemplate
vcenter.resource.virtual_machine_group.VirtualMachineGroup
vcenter.resource.virtual_machine_storage_rule.VirtualMachineStorageRule
vcenter.resource.virtual_machine_to_host_rule.VirtualMachineToHostRule
vcenter.resource.virtual_machine_to_virtual_machine_rule.VirtualMachineToVirtualMachineRule
- Handlers
vcenter.handler.virtual_machine.RenameVirtualMachineHandler
vcenter.handler.virtual_machine.VcenterVirtualMachineFromTemplateHandler
vcenter.handler.virtual_machine.VcenterVirtualMachineFromOvaHandler
vcenter.handler.virtual_machine.ESXIVirtualMachineFromOvaHandler
vcenter.handler.virtual_machine.VcenterVirtualMachineFromContentLibrary
vcenter.unmanaged.VirtualMachineDiscoveryHandler
vcenter.handler.distributed_virtual_portgroup.PortGroupHandler
vcenter.handler.host_dnsconfig.HostDnsConfigHandler
vcenter.handler.host_group.HostGroupHandler
vcenter.handler.host_portgroup.HostPortGroupHandler
vcenter.handler.host_vnic.HostVirtualNicHandler
vcenter.handler.host_vswitch.HostVirtualSwitchHandler
vcenter.handler.iso.CreateISOHandler
vcenter.handler.virtual_disk.VirtualDiskHandler
vcenter.handler.virtual_machine_group.VirtualMachineGroupHandler
vcenter.handler.virtual_machine_storage_rule.VirtualMachineStorageRuleHandler
vcenter.handler.virtual_machine_to_host_rule.VirtualMachineToHostRuleHandler
vcenter.handler.virtual_machine_to_virtual_machine_rule.VirtualMachineToVirtualMachineRuleHandler
vcenter.handler.vmdk_storage_rule.VMDKStorageRuleHandler
- Module aci
- REST API reference
- Compatibility
- API self-referencing links