{"docs":{"info":"

The Foreman is aimed to be a single address for all machines life cycle management.

\n","doc_url":"/apidoc","api_url":"/api","copyright":"","name":"Foreman","resources":{"architectures":{"version":"1","methods":[{"see_url":null,"params":[{"description":"

filter results

\n","allow_nil":false,"required":false,"validator":"Must be String","name":"search","expected_type":"string","full_name":"search"},{"description":"

sort results

\n","allow_nil":false,"required":false,"validator":"Must be String","name":"order","expected_type":"string","full_name":"order"}],"errors":[],"examples":[],"full_description":"","see":null,"apis":[{"short_description":"List all architectures.","http_method":"GET","api_url":"/api/architectures"}],"doc_url":"/apidoc/architectures/index","name":"index","formats":[]},{"see_url":null,"params":[{"description":"","allow_nil":false,"required":true,"validator":"Must be an identifier, string from 2 to 128 characters containting only alphanumeric characters, space, '_', '-' with no leading or trailing space..","name":"id","expected_type":"string","full_name":"id"}],"errors":[],"examples":[],"full_description":"","see":null,"apis":[{"short_description":"Show an architecture.","http_method":"GET","api_url":"/api/architectures/:id"}],"doc_url":"/apidoc/architectures/show","name":"show","formats":[]},{"see_url":null,"params":[{"params":[{"description":"","allow_nil":false,"required":true,"validator":"Must be String","name":"name","expected_type":"string","full_name":"architecture[name]"}],"description":"","allow_nil":false,"required":true,"validator":"Must be a Hash","name":"architecture","expected_type":"hash","full_name":"architecture"}],"errors":[],"examples":[],"full_description":"","see":null,"apis":[{"short_description":"Create an architecture.","http_method":"POST","api_url":"/api/architectures"}],"doc_url":"/apidoc/architectures/create","name":"create","formats":[]},{"see_url":null,"params":[{"description":"","allow_nil":false,"required":true,"validator":"Must be String","name":"id","expected_type":"string","full_name":"id"},{"params":[{"description":"","allow_nil":false,"required":false,"validator":"Must be String","name":"name","expected_type":"string","full_name":"architecture[name]"}],"description":"","allow_nil":false,"required":true,"validator":"Must be a Hash","name":"architecture","expected_type":"hash","full_name":"architecture"}],"errors":[],"examples":[],"full_description":"","see":null,"apis":[{"short_description":"Update an architecture.","http_method":"PUT","api_url":"/api/architectures/:id"}],"doc_url":"/apidoc/architectures/update","name":"update","formats":[]},{"see_url":null,"params":[{"description":"","allow_nil":false,"required":true,"validator":"Must be String","name":"id","expected_type":"string","full_name":"id"}],"errors":[],"examples":[],"full_description":"","see":null,"apis":[{"short_description":"Delete an architecture.","http_method":"DELETE","api_url":"/api/architectures/:id"}],"doc_url":"/apidoc/architectures/destroy","name":"destroy","formats":[]}],"full_description":"","short_description":"","doc_url":"/apidoc/architectures","name":"Architectures","api_url":"/api","formats":[]},"users":{"version":"1","methods":[{"see_url":null,"params":[{"description":"

filter results

\n","allow_nil":false,"required":false,"validator":"Must be String","name":"search","expected_type":"string","full_name":"search"},{"description":"

sort results

\n","allow_nil":false,"required":false,"validator":"Must be String","name":"order","expected_type":"string","full_name":"order"}],"errors":[],"examples":[],"full_description":"","see":null,"apis":[{"short_description":"List all users.","http_method":"GET","api_url":"/api/users"}],"doc_url":"/apidoc/users/index","name":"index","formats":[]},{"see_url":null,"params":[{"description":"","allow_nil":false,"required":true,"validator":"Must be String","name":"id","expected_type":"string","full_name":"id"}],"errors":[],"examples":[],"full_description":"","see":null,"apis":[{"short_description":"Show an user.","http_method":"GET","api_url":"/api/users/:id"}],"doc_url":"/apidoc/users/show","name":"show","formats":[]},{"see_url":null,"params":[{"params":[{"description":"","allow_nil":false,"required":true,"validator":"Must be String","name":"login","expected_type":"string","full_name":"user[login]"},{"description":"","allow_nil":false,"required":false,"validator":"Must be String","name":"firstname","expected_type":"string","full_name":"user[firstname]"},{"description":"","allow_nil":false,"required":false,"validator":"Must be String","name":"lastname","expected_type":"string","full_name":"user[lastname]"},{"description":"","allow_nil":false,"required":true,"validator":"Must be String","name":"mail","expected_type":"string","full_name":"user[mail]"},{"description":"

Is an admin account?

\n","allow_nil":false,"required":false,"validator":"Must be 'true' or 'false'","name":"admin","expected_type":"string","full_name":"user[admin]"},{"description":"","allow_nil":false,"required":true,"validator":"Must be String","name":"password","expected_type":"string","full_name":"user[password]"},{"description":"","allow_nil":false,"required":true,"validator":"Must be Integer","name":"auth_source_id","expected_type":"numeric","full_name":"user[auth_source_id]"}],"description":"","allow_nil":false,"required":true,"validator":"Must be a Hash","name":"user","expected_type":"hash","full_name":"user"}],"errors":[],"examples":[],"full_description":"

Adds role 'Anonymous' to the user by default

\n","see":null,"apis":[{"short_description":"Create an user.","http_method":"POST","api_url":"/api/users"}],"doc_url":"/apidoc/users/create","name":"create","formats":[]},{"see_url":null,"params":[{"description":"","allow_nil":false,"required":true,"validator":"Must be String","name":"id","expected_type":"string","full_name":"id"},{"params":[{"description":"","allow_nil":false,"required":false,"validator":"Must be String","name":"login","expected_type":"string","full_name":"user[login]"},{"description":"","allow_nil":true,"required":false,"validator":"Must be String","name":"firstname","expected_type":"string","full_name":"user[firstname]"},{"description":"","allow_nil":true,"required":false,"validator":"Must be String","name":"lastname","expected_type":"string","full_name":"user[lastname]"},{"description":"","allow_nil":false,"required":false,"validator":"Must be String","name":"mail","expected_type":"string","full_name":"user[mail]"},{"description":"

Is an admin account?

\n","allow_nil":false,"required":false,"validator":"Must be 'true' or 'false'","name":"admin","expected_type":"string","full_name":"user[admin]"},{"description":"","allow_nil":false,"required":true,"validator":"Must be String","name":"password","expected_type":"string","full_name":"user[password]"}],"description":"","allow_nil":false,"required":true,"validator":"Must be a Hash","name":"user","expected_type":"hash","full_name":"user"}],"errors":[],"examples":[],"full_description":"

Adds role 'Anonymous' to the user if it is not already present.\nOnly admin can set admin account.

\n","see":null,"apis":[{"short_description":"Update an user.","http_method":"PUT","api_url":"/api/users/:id"}],"doc_url":"/apidoc/users/update","name":"update","formats":[]},{"see_url":null,"params":[{"description":"","allow_nil":false,"required":true,"validator":"Must be String","name":"id","expected_type":"string","full_name":"id"}],"errors":[],"examples":[],"full_description":"","see":null,"apis":[{"short_description":"Delete an user.","http_method":"DELETE","api_url":"/api/users/:id"}],"doc_url":"/apidoc/users/destroy","name":"destroy","formats":[]}],"full_description":"","short_description":"","doc_url":"/apidoc/users","name":"Users","api_url":"/api","formats":[]},"operatingsystems":{"version":"1","methods":[{"see_url":null,"params":[{"description":"

filter results

\n","allow_nil":false,"required":false,"validator":"Must be String","name":"search","expected_type":"string","full_name":"search"},{"description":"

for example, name ASC, or name DESC

\n","allow_nil":false,"required":false,"validator":"Must be String","name":"order","expected_type":"string","full_name":"order"}],"errors":[],"examples":[],"full_description":"","see":null,"apis":[{"short_description":"List all operating systems.","http_method":"GET","api_url":"/api/operatingsystems"}],"doc_url":"/apidoc/operatingsystems/index","name":"index","formats":[]},{"see_url":null,"params":[{"description":"","allow_nil":false,"required":true,"validator":"Must be String","name":"id","expected_type":"string","full_name":"id"}],"errors":[],"examples":[],"full_description":"","see":null,"apis":[{"short_description":"Show an OS.","http_method":"GET","api_url":"/api/operatingsystems/:id"}],"doc_url":"/apidoc/operatingsystems/show","name":"show","formats":[]},{"see_url":null,"params":[{"params":[{"description":"","allow_nil":false,"required":true,"validator":"Must match regular expression /\\A(\\S+)\\Z/.","name":"name","expected_type":"string","full_name":"operatingsystem[name]"},{"description":"","allow_nil":false,"required":true,"validator":"Must be String","name":"major","expected_type":"string","full_name":"operatingsystem[major]"},{"description":"","allow_nil":false,"required":true,"validator":"Must be String","name":"minor","expected_type":"string","full_name":"operatingsystem[minor]"}],"description":"","allow_nil":false,"required":true,"validator":"Must be a Hash","name":"operatingsystem","expected_type":"hash","full_name":"operatingsystem"}],"errors":[],"examples":[],"full_description":"","see":null,"apis":[{"short_description":"Create an OS.","http_method":"POST","api_url":"/api/operatingsystems"}],"doc_url":"/apidoc/operatingsystems/create","name":"create","formats":[]},{"see_url":null,"params":[{"description":"","allow_nil":false,"required":true,"validator":"Must be String","name":"id","expected_type":"string","full_name":"id"},{"params":[{"description":"","allow_nil":false,"required":false,"validator":"Must match regular expression /\\A(\\S+)\\Z/.","name":"name","expected_type":"string","full_name":"operatingsystem[name]"},{"description":"","allow_nil":false,"required":false,"validator":"Must be String","name":"major","expected_type":"string","full_name":"operatingsystem[major]"},{"description":"","allow_nil":false,"required":false,"validator":"Must be String","name":"minor","expected_type":"string","full_name":"operatingsystem[minor]"}],"description":"","allow_nil":false,"required":true,"validator":"Must be a Hash","name":"operatingsystem","expected_type":"hash","full_name":"operatingsystem"}],"errors":[],"examples":[],"full_description":"","see":null,"apis":[{"short_description":"Update an OS.","http_method":"PUT","api_url":"/api/operatingsystems/:id"}],"doc_url":"/apidoc/operatingsystems/update","name":"update","formats":[]},{"see_url":null,"params":[{"description":"","allow_nil":false,"required":true,"validator":"Must be String","name":"id","expected_type":"string","full_name":"id"}],"errors":[],"examples":[],"full_description":"","see":null,"apis":[{"short_description":"Delete a bookmark.","http_method":"DELETE","api_url":"/api/operatingsystems/:id"}],"doc_url":"/apidoc/operatingsystems/destroy","name":"destroy","formats":[]},{"see_url":null,"params":[{"description":"","allow_nil":false,"required":true,"validator":"Must be String","name":"id","expected_type":"string","full_name":"id"},{"description":"","allow_nil":false,"required":false,"validator":"Must be String","name":"medium","expected_type":"string","full_name":"medium"},{"description":"","allow_nil":false,"required":false,"validator":"Must be String","name":"architecture","expected_type":"string","full_name":"architecture"}],"errors":[],"examples":[],"full_description":"","see":null,"apis":[{"short_description":"List boot files an OS.","http_method":"GET","api_url":"/api/operatingsystems/:id/bootfiles"}],"doc_url":"/apidoc/operatingsystems/bootfiles","name":"bootfiles","formats":[]}],"full_description":"","short_description":"","doc_url":"/apidoc/operatingsystems","name":"Operating systems","api_url":"/api","formats":[]},"bookmarks":{"version":"1","methods":[{"see_url":null,"params":[],"errors":[],"examples":[],"full_description":"","see":null,"apis":[{"short_description":"List all bookmarks.","http_method":"GET","api_url":"/api/bookmarks"}],"doc_url":"/apidoc/bookmarks/index","name":"index","formats":[]},{"see_url":null,"params":[{"description":"","allow_nil":false,"required":true,"validator":"Must be String","name":"id","expected_type":"string","full_name":"id"}],"errors":[],"examples":[],"full_description":"","see":null,"apis":[{"short_description":"Show a bookmark.","http_method":"GET","api_url":"/api/bookmarks/:id"}],"doc_url":"/apidoc/bookmarks/show","name":"show","formats":[]},{"see_url":null,"params":[{"params":[{"description":"","allow_nil":false,"required":true,"validator":"Must be String","name":"name","expected_type":"string","full_name":"bookmark[name]"},{"description":"","allow_nil":false,"required":true,"validator":"Must be String","name":"controller","expected_type":"string","full_name":"bookmark[controller]"},{"description":"","allow_nil":false,"required":true,"validator":"Must be String","name":"query","expected_type":"string","full_name":"bookmark[query]"}],"description":"","allow_nil":false,"required":true,"validator":"Must be a Hash","name":"bookmark","expected_type":"hash","full_name":"bookmark"}],"errors":[],"examples":[],"full_description":"","see":null,"apis":[{"short_description":"Create a bookmark.","http_method":"POST","api_url":"/api/bookmarks"}],"doc_url":"/apidoc/bookmarks/create","name":"create","formats":[]},{"see_url":null,"params":[{"description":"","allow_nil":false,"required":true,"validator":"Must be String","name":"id","expected_type":"string","full_name":"id"},{"params":[{"description":"","allow_nil":true,"required":false,"validator":"Must be String","name":"name","expected_type":"string","full_name":"bookmark[name]"},{"description":"","allow_nil":true,"required":false,"validator":"Must be String","name":"controller","expected_type":"string","full_name":"bookmark[controller]"},{"description":"","allow_nil":true,"required":false,"validator":"Must be String","name":"query","expected_type":"string","full_name":"bookmark[query]"}],"description":"","allow_nil":false,"required":true,"validator":"Must be a Hash","name":"bookmark","expected_type":"hash","full_name":"bookmark"}],"errors":[],"examples":[],"full_description":"","see":null,"apis":[{"short_description":"Update a bookmark.","http_method":"PUT","api_url":"/api/bookmarks/:id"}],"doc_url":"/apidoc/bookmarks/update","name":"update","formats":[]},{"see_url":null,"params":[{"description":"","allow_nil":false,"required":true,"validator":"Must be String","name":"id","expected_type":"string","full_name":"id"}],"errors":[],"examples":[],"full_description":"","see":null,"apis":[{"short_description":"Delete a bookmark.","http_method":"DELETE","api_url":"/api/bookmarks/:id"}],"doc_url":"/apidoc/bookmarks/destroy","name":"destroy","formats":[]}],"full_description":"","short_description":"","doc_url":"/apidoc/bookmarks","name":"Bookmarks","api_url":"/api","formats":[]},"domains":{"version":"1","methods":[{"see_url":null,"params":[{"description":"

Filter results

\n","allow_nil":false,"required":false,"validator":"Must be String","name":"search","expected_type":"string","full_name":"search"},{"description":"

Sort results

\n","allow_nil":false,"required":false,"validator":"Must be String","name":"order","expected_type":"string","full_name":"order"}],"errors":[],"examples":[],"full_description":"","see":null,"apis":[{"short_description":"List of domains","http_method":"GET","api_url":"/api/domains"}],"doc_url":"/apidoc/domains/index","name":"index","formats":[]},{"see_url":null,"params":[{"description":"","allow_nil":false,"required":true,"validator":"Must be String","name":"id","expected_type":"string","full_name":"id"}],"errors":[],"examples":[],"full_description":"","see":null,"apis":[{"short_description":"Show a domain.","http_method":"GET","api_url":"/api/domains/:id"}],"doc_url":"/apidoc/domains/show","name":"show","formats":[]},{"see_url":null,"params":[{"params":[{"description":"

The full DNS Domain name

\n","allow_nil":false,"required":true,"validator":"Must be String","name":"name","expected_type":"string","full_name":"domain[name]"},{"description":"

Full name describing the domain

\n","allow_nil":true,"required":false,"validator":"Must be String","name":"fullname","expected_type":"string","full_name":"domain[fullname]"},{"description":"

DNS Proxy to use within this domain

\n","allow_nil":true,"required":false,"validator":"Must be a number.","name":"dns_id","expected_type":"string","full_name":"domain[dns_id]"},{"description":"

Array of parameters (name, value)

\n","allow_nil":false,"required":false,"validator":"Must be Array","name":"domain_parameters_attributes","expected_type":"string","full_name":"domain[domain_parameters_attributes]"}],"description":"","allow_nil":false,"required":true,"validator":"Must be a Hash","name":"domain","expected_type":"hash","full_name":"domain"}],"errors":[],"examples":[],"full_description":"

The fullname field is used for human readability in reports\nand other pages that refer to domains, and also available as\nan external node parameter

\n","see":null,"apis":[{"short_description":"Create a domain.","http_method":"POST","api_url":"/api/domains"}],"doc_url":"/apidoc/domains/create","name":"create","formats":[]},{"see_url":null,"params":[{"description":"","allow_nil":false,"required":true,"validator":"Must be String","name":"id","expected_type":"string","full_name":"id"},{"params":[{"description":"

The full DNS Domain name

\n","allow_nil":true,"required":true,"validator":"Must be String","name":"name","expected_type":"string","full_name":"domain[name]"},{"description":"

Full name describing the domain

\n","allow_nil":true,"required":false,"validator":"Must be String","name":"fullname","expected_type":"string","full_name":"domain[fullname]"},{"description":"

DNS Proxy to use within this domain

\n","allow_nil":true,"required":false,"validator":"Must be a number.","name":"dns_id","expected_type":"string","full_name":"domain[dns_id]"},{"description":"

Array of parameters (name, value)

\n","allow_nil":false,"required":false,"validator":"Must be Array","name":"domain_parameters_attributes","expected_type":"string","full_name":"domain[domain_parameters_attributes]"}],"description":"","allow_nil":false,"required":true,"validator":"Must be a Hash","name":"domain","expected_type":"hash","full_name":"domain"}],"errors":[],"examples":[],"full_description":"","see":null,"apis":[{"short_description":"Update a domain.","http_method":"PUT","api_url":"/api/domains/:id"}],"doc_url":"/apidoc/domains/update","name":"update","formats":[]},{"see_url":null,"params":[{"description":"","allow_nil":false,"required":true,"validator":"Must be String","name":"id","expected_type":"string","full_name":"id"}],"errors":[],"examples":[],"full_description":"","see":null,"apis":[{"short_description":"Delete a domain.","http_method":"DELETE","api_url":"/api/domains/:id"}],"doc_url":"/apidoc/domains/destroy","name":"destroy","formats":[]}],"full_description":"

Foreman considers a domain and a DNS zone as the same thing. That is, if you\nare planning to manage a site where all the machines are or the form\nhostname.somewhere.com then the domain is somewhere.com.\nThis allows Foreman to associate a puppet variable with a domain/site\nand automatically append this variable to all external node requests made\nby machines at that site.

\n","short_description":"","doc_url":"/apidoc/domains","name":"Domains","api_url":"/api","formats":[]},"media":{"version":"1","methods":[{"see_url":null,"params":[{"description":"

filter results

\n","allow_nil":false,"required":false,"validator":"Must be String","name":"search","expected_type":"string","full_name":"search"},{"description":"

for example, name ASC, or name DESC

\n","allow_nil":false,"required":false,"validator":"Must be String","name":"order","expected_type":"string","full_name":"order"}],"errors":[],"examples":[],"full_description":"","see":null,"apis":[{"short_description":"List all media.","http_method":"GET","api_url":"/api/media"}],"doc_url":"/apidoc/media/index","name":"index","formats":[]},{"see_url":null,"params":[{"description":"","allow_nil":false,"required":true,"validator":"Must be String","name":"id","expected_type":"string","full_name":"id"}],"errors":[],"examples":[],"full_description":"","see":null,"apis":[{"short_description":"Show a medium.","http_method":"GET","api_url":"/api/media/:id"}],"doc_url":"/apidoc/media/show","name":"show","formats":[]},{"see_url":null,"params":[{"params":[{"description":"

Name of media

\n","allow_nil":false,"required":true,"validator":"Must be String","name":"name","expected_type":"string","full_name":"medium[name]"},{"description":"

The path to the medium, can be a URL or a valid NFS server (exclusive of the architecture).

\n\n

for example http://mirror.averse.net/centos/$version/os/$arch\nwhere $arch will be substituted for the host's actual OS architecture and $version, $major and $minor\nwill be substituted for the version of the operating system.

\n\n

Solaris and Debian media may also use $release.

\n","allow_nil":false,"required":true,"validator":"Must be String","name":"path","expected_type":"string","full_name":"medium[path]"},{"description":"

The family that the operating system belongs to.

\n\n

Available families:

\n\n\n","allow_nil":false,"required":false,"validator":"Must be String","name":"os_family","expected_type":"string","full_name":"medium[os_family]"}],"description":"","allow_nil":false,"required":true,"validator":"Must be a Hash","name":"medium","expected_type":"hash","full_name":"medium"}],"errors":[],"examples":[],"full_description":"","see":null,"apis":[{"short_description":"Create a medium.","http_method":"POST","api_url":"/api/medium"}],"doc_url":"/apidoc/media/create","name":"create","formats":[]},{"see_url":null,"params":[{"description":"","allow_nil":false,"required":true,"validator":"Must be String","name":"id","expected_type":"string","full_name":"id"},{"params":[{"description":"

Name of media

\n","allow_nil":false,"required":false,"validator":"Must be String","name":"name","expected_type":"string","full_name":"medium[name]"},{"description":"

The path to the medium, can be a URL or a valid NFS server (exclusive of the architecture).

\n\n

for example http://mirror.averse.net/centos/$version/os/$arch\nwhere $arch will be substituted for the host's actual OS architecture and $version, $major and $minor\nwill be substituted for the version of the operating system.

\n\n

Solaris and Debian media may also use $release.

\n","allow_nil":false,"required":false,"validator":"Must be String","name":"path","expected_type":"string","full_name":"medium[path]"},{"description":"

The family that the operating system belongs to.

\n\n

Available families:

\n\n\n","allow_nil":true,"required":false,"validator":"Must be String","name":"os_family","expected_type":"string","full_name":"medium[os_family]"}],"description":"","allow_nil":false,"required":true,"validator":"Must be a Hash","name":"medium","expected_type":"hash","full_name":"medium"}],"errors":[],"examples":[],"full_description":"","see":null,"apis":[{"short_description":"Update a medium.","http_method":"PUT","api_url":"/api/media/:id"}],"doc_url":"/apidoc/media/update","name":"update","formats":[]},{"see_url":null,"params":[{"description":"","allow_nil":false,"required":true,"validator":"Must be String","name":"id","expected_type":"string","full_name":"id"}],"errors":[],"examples":[],"full_description":"","see":null,"apis":[{"short_description":"Delete a medium.","http_method":"DELETE","api_url":"/api/media/:id"}],"doc_url":"/apidoc/media/destroy","name":"destroy","formats":[]}],"full_description":"","short_description":"","doc_url":"/apidoc/media","name":"Media","api_url":"/api","formats":[]},"dashboard":{"version":"1","methods":[{"see_url":null,"params":[{"description":"

filter results

\n","allow_nil":false,"required":false,"validator":"Must be String","name":"search","expected_type":"string","full_name":"search"}],"errors":[],"examples":[],"full_description":"","see":null,"apis":[{"short_description":"Get Dashboard results","http_method":"GET","api_url":"/api/dashboard"}],"doc_url":"/apidoc/dashboard/index","name":"index","formats":[]}],"full_description":"","short_description":"","doc_url":"/apidoc/dashboard","name":"Dashboard","api_url":"/api","formats":[]},"subnets":{"version":"1","methods":[{"see_url":null,"params":[{"description":"

Filter results

\n","allow_nil":false,"required":false,"validator":"Must be String","name":"search","expected_type":"string","full_name":"search"},{"description":"

Sort results

\n","allow_nil":false,"required":false,"validator":"Must be String","name":"order","expected_type":"string","full_name":"order"}],"errors":[],"examples":[],"full_description":"","see":null,"apis":[{"short_description":"List of subnets","http_method":"GET","api_url":"/api/subnets"}],"doc_url":"/apidoc/subnets/index","name":"index","formats":[]},{"see_url":null,"params":[{"params":[{"description":"

Subnet name

\n","allow_nil":false,"required":true,"validator":"Must be String","name":"name","expected_type":"string","full_name":"subnet[name]"},{"description":"

Subnet network

\n","allow_nil":false,"required":true,"validator":"Must be String","name":"network","expected_type":"string","full_name":"subnet[network]"},{"description":"

Netmask for this subnet

\n","allow_nil":false,"required":true,"validator":"Must be String","name":"mask","expected_type":"string","full_name":"subnet[mask]"},{"description":"

Primary DNS for this subnet

\n","allow_nil":false,"required":false,"validator":"Must be String","name":"gateway","expected_type":"string","full_name":"subnet[gateway]"},{"description":"

Primary DNS for this subnet

\n","allow_nil":false,"required":false,"validator":"Must be String","name":"dns_primary","expected_type":"string","full_name":"subnet[dns_primary]"},{"description":"

Secondary DNS for this subnet

\n","allow_nil":false,"required":false,"validator":"Must be String","name":"dns_secondary","expected_type":"string","full_name":"subnet[dns_secondary]"},{"description":"

Starting IP Address for IP auto suggestion

\n","allow_nil":false,"required":false,"validator":"Must be String","name":"from","expected_type":"string","full_name":"subnet[from]"},{"description":"

Ending IP Address for IP auto suggestion

\n","allow_nil":false,"required":false,"validator":"Must be String","name":"to","expected_type":"string","full_name":"subnet[to]"},{"description":"

VLAN ID for this subnet

\n","allow_nil":false,"required":false,"validator":"Must be String","name":"vlanid","expected_type":"string","full_name":"subnet[vlanid]"},{"description":"

Domains in which this subnet is part

\n","allow_nil":false,"required":false,"validator":"Must be Array","name":"domain_ids","expected_type":"string","full_name":"subnet[domain_ids]"},{"description":"

DHCP Proxy to use within this subnet

\n","allow_nil":false,"required":false,"validator":"Must be a number.","name":"dhcp_id","expected_type":"string","full_name":"subnet[dhcp_id]"},{"description":"

TFTP Proxy to use within this subnet

\n","allow_nil":false,"required":false,"validator":"Must be a number.","name":"tftp_id","expected_type":"string","full_name":"subnet[tftp_id]"},{"description":"

DNS Proxy to use within this subnet

\n","allow_nil":false,"required":false,"validator":"Must be a number.","name":"dns_id","expected_type":"string","full_name":"subnet[dns_id]"}],"description":"","allow_nil":false,"required":true,"validator":"Must be a Hash","name":"subnet","expected_type":"hash","full_name":"subnet"}],"errors":[],"examples":[],"full_description":"","see":null,"apis":[{"short_description":"Create a subnet","http_method":"POST","api_url":"/api/subnets"}],"doc_url":"/apidoc/subnets/create","name":"create","formats":[]},{"see_url":null,"params":[{"description":"

Subnet numeric identifier

\n","allow_nil":false,"required":true,"validator":"Must be a number.","name":"id","expected_type":"string","full_name":"id"},{"params":[{"description":"

Subnet name

\n","allow_nil":false,"required":true,"validator":"Must be String","name":"name","expected_type":"string","full_name":"subnet[name]"},{"description":"

Subnet network

\n","allow_nil":false,"required":true,"validator":"Must be String","name":"network","expected_type":"string","full_name":"subnet[network]"},{"description":"

Netmask for this subnet

\n","allow_nil":false,"required":true,"validator":"Must be String","name":"mask","expected_type":"string","full_name":"subnet[mask]"},{"description":"

Primary DNS for this subnet

\n","allow_nil":true,"required":false,"validator":"Must be String","name":"gateway","expected_type":"string","full_name":"subnet[gateway]"},{"description":"

Primary DNS for this subnet

\n","allow_nil":true,"required":false,"validator":"Must be String","name":"dns_primary","expected_type":"string","full_name":"subnet[dns_primary]"},{"description":"

Secondary DNS for this subnet

\n","allow_nil":true,"required":false,"validator":"Must be String","name":"dns_secondary","expected_type":"string","full_name":"subnet[dns_secondary]"},{"description":"

Starting IP Address for IP auto suggestion

\n","allow_nil":true,"required":false,"validator":"Must be String","name":"from","expected_type":"string","full_name":"subnet[from]"},{"description":"

Ending IP Address for IP auto suggestion

\n","allow_nil":true,"required":false,"validator":"Must be String","name":"to","expected_type":"string","full_name":"subnet[to]"},{"description":"

VLAN ID for this subnet

\n","allow_nil":true,"required":false,"validator":"Must be String","name":"vlanid","expected_type":"string","full_name":"subnet[vlanid]"},{"description":"

Domains in which this subnet is part

\n","allow_nil":true,"required":false,"validator":"Must be Array","name":"domain_ids","expected_type":"string","full_name":"subnet[domain_ids]"},{"description":"

DHCP Proxy to use within this subnet

\n","allow_nil":true,"required":false,"validator":"Must be a number.","name":"dhcp_id","expected_type":"string","full_name":"subnet[dhcp_id]"},{"description":"

TFTP Proxy to use within this subnet

\n","allow_nil":true,"required":false,"validator":"Must be a number.","name":"tftp_id","expected_type":"string","full_name":"subnet[tftp_id]"},{"description":"

DNS Proxy to use within this subnet

\n","allow_nil":true,"required":false,"validator":"Must be a number.","name":"dns_id","expected_type":"string","full_name":"subnet[dns_id]"}],"description":"","allow_nil":false,"required":true,"validator":"Must be a Hash","name":"subnet","expected_type":"hash","full_name":"subnet"}],"errors":[],"examples":[],"full_description":"","see":null,"apis":[{"short_description":"Update a subnet","http_method":"PUT","api_url":"/api/subnets/:id"}],"doc_url":"/apidoc/subnets/update","name":"update","formats":[]},{"see_url":null,"params":[{"description":"

Subnet numeric identifier

\n","allow_nil":false,"required":true,"validator":"Must be a number.","name":"id","expected_type":"string","full_name":"id"}],"errors":[],"examples":[],"full_description":"","see":null,"apis":[{"short_description":"Delete a subnet","http_method":"DELETE","api_url":"/api/subnets/:id"}],"doc_url":"/apidoc/subnets/destroy","name":"destroy","formats":[]},{"see_url":null,"params":[{"description":"","allow_nil":false,"required":false,"validator":"Must be a number.","name":"subnet_id","expected_type":"string","full_name":"subnet_id"},{"description":"","allow_nil":false,"required":false,"validator":"Must be String","name":"host_mac","expected_type":"string","full_name":"host_mac"}],"errors":[],"examples":[],"full_description":"","see":null,"apis":[{"short_description":"Query subnet DHCP proxy for an unused IP","http_method":"POST","api_url":"/api/subnets/freeip"}],"doc_url":"/apidoc/subnets/freeip","name":"freeip","formats":[]}],"full_description":"","short_description":"","doc_url":"/apidoc/subnets","name":"Subnets","api_url":"/api","formats":[]},"home":{"version":"1","methods":[{"see_url":null,"params":[],"errors":[],"examples":[],"full_description":"","see":null,"apis":[{"short_description":"Show available links.","http_method":"GET","api_url":"/api"}],"doc_url":"/apidoc/home/index","name":"index","formats":[]},{"see_url":null,"params":[],"errors":[],"examples":[],"full_description":"","see":null,"apis":[{"short_description":"Show status.","http_method":"GET","api_url":"/api/status"}],"doc_url":"/apidoc/home/status","name":"status","formats":[]}],"full_description":"","short_description":"","doc_url":"/apidoc/home","name":"Home","api_url":"/api","formats":[]},"config_templates":{"version":"1","methods":[{"see_url":null,"params":[{"description":"

filter results

\n","allow_nil":false,"required":false,"validator":"Must be String","name":"search","expected_type":"string","full_name":"search"},{"description":"

sort results

\n","allow_nil":false,"required":false,"validator":"Must be String","name":"order","expected_type":"string","full_name":"order"}],"errors":[],"examples":[],"full_description":"","see":null,"apis":[{"short_description":"List templates","http_method":"GET","api_url":"/api/config_templates"}],"doc_url":"/apidoc/config_templates/index","name":"index","formats":[]},{"see_url":null,"params":[{"description":"","allow_nil":false,"required":true,"validator":"Must be String","name":"id","expected_type":"string","full_name":"id"}],"errors":[],"examples":[],"full_description":"","see":null,"apis":[{"short_description":"Show template details","http_method":"GET","api_url":"/api/config_templates/:id"}],"doc_url":"/apidoc/config_templates/show","name":"show","formats":[]},{"see_url":null,"params":[{"params":[{"description":"

template name

\n","allow_nil":false,"required":true,"validator":"Must be String","name":"name","expected_type":"string","full_name":"config_template[name]"},{"description":"","allow_nil":false,"required":true,"validator":"Must be String","name":"template","expected_type":"string","full_name":"config_template[template]"},{"description":"","allow_nil":true,"required":false,"validator":"Must be 'true' or 'false'","name":"snippet","expected_type":"string","full_name":"config_template[snippet]"},{"description":"","allow_nil":true,"required":false,"validator":"Must be String","name":"audit_comment","expected_type":"string","full_name":"config_template[audit_comment]"},{"description":"

not relevant for snippet

\n","allow_nil":true,"required":false,"validator":"Must be a number.","name":"template_kind_id","expected_type":"string","full_name":"config_template[template_kind_id]"},{"description":"

Array of template combinations (hostgroupid, environmentid)

\n","allow_nil":false,"required":false,"validator":"Must be Array","name":"template_combinations_attributes","expected_type":"string","full_name":"config_template[template_combinations_attributes]"},{"description":"

Array of operating systems ID to associate the template with

\n","allow_nil":false,"required":false,"validator":"Must be Array","name":"operatingsystem_ids","expected_type":"string","full_name":"config_template[operatingsystem_ids]"}],"description":"","allow_nil":false,"required":true,"validator":"Must be a Hash","name":"config_template","expected_type":"hash","full_name":"config_template"}],"errors":[],"examples":[],"full_description":"","see":null,"apis":[{"short_description":"Create a template","http_method":"POST","api_url":"/api/config_templates"}],"doc_url":"/apidoc/config_templates/create","name":"create","formats":[]},{"see_url":null,"params":[{"description":"","allow_nil":false,"required":true,"validator":"Must be String","name":"id","expected_type":"string","full_name":"id"},{"params":[{"description":"

template name

\n","allow_nil":false,"required":true,"validator":"Must be String","name":"name","expected_type":"string","full_name":"config_template[name]"},{"description":"","allow_nil":false,"required":true,"validator":"Must be one of: String, File.","name":"template","expected_type":"string","full_name":"config_template[template]"},{"description":"","allow_nil":false,"required":false,"validator":"Must be 'true' or 'false'","name":"snippet","expected_type":"string","full_name":"config_template[snippet]"},{"description":"","allow_nil":false,"required":false,"validator":"Must be String","name":"audit_comment","expected_type":"string","full_name":"config_template[audit_comment]"},{"description":"

not relevant for snippet

\n","allow_nil":false,"required":false,"validator":"Must be a number.","name":"template_kind_id","expected_type":"string","full_name":"config_template[template_kind_id]"},{"description":"

Array of template combinations (hostgroupid, environmentid)

\n","allow_nil":false,"required":false,"validator":"Must be Array","name":"template_combinations_attributes","expected_type":"string","full_name":"config_template[template_combinations_attributes]"},{"description":"

Array of operating systems ID to associate the template with

\n","allow_nil":false,"required":false,"validator":"Must be Array","name":"operatingsystem_ids","expected_type":"string","full_name":"config_template[operatingsystem_ids]"}],"description":"","allow_nil":false,"required":true,"validator":"Must be a Hash","name":"config_template","expected_type":"hash","full_name":"config_template"}],"errors":[],"examples":[],"full_description":"","see":null,"apis":[{"short_description":"Update a template","http_method":"PUT","api_url":"/api/config_templates/:id"}],"doc_url":"/apidoc/config_templates/update","name":"update","formats":[]},{"see_url":null,"params":[{"description":"

template version

\n","allow_nil":false,"required":false,"validator":"Must be String","name":"version","expected_type":"string","full_name":"version"}],"errors":[],"examples":[],"full_description":"","see":null,"apis":[{"short_description":null,"http_method":"GET","api_url":"/api/config_templates/revision"}],"doc_url":"/apidoc/config_templates/revision","name":"revision","formats":[]},{"see_url":null,"params":[{"description":"","allow_nil":false,"required":true,"validator":"Must be String","name":"id","expected_type":"string","full_name":"id"}],"errors":[],"examples":[],"full_description":"","see":null,"apis":[{"short_description":"Delete a template","http_method":"DELETE","api_url":"/api/config_templates/:id"}],"doc_url":"/apidoc/config_templates/destroy","name":"destroy","formats":[]},{"see_url":null,"params":[],"errors":[],"examples":[],"full_description":"","see":null,"apis":[{"short_description":"Change the default PXE menu on all configured TFTP servers","http_method":"GET","api_url":"/api/config_templates/build_pxe_default"}],"doc_url":"/apidoc/config_templates/build_pxe_default","name":"build_pxe_default","formats":[]}],"full_description":"","short_description":"","doc_url":"/apidoc/config_templates","name":"Config templates","api_url":"/api","formats":[]},"environments":{"version":"1","methods":[{"see_url":null,"params":[{"description":"

Filter results

\n","allow_nil":false,"required":false,"validator":"Must be String","name":"search","expected_type":"string","full_name":"search"},{"description":"

Sort results

\n","allow_nil":false,"required":false,"validator":"Must be String","name":"order","expected_type":"string","full_name":"order"}],"errors":[],"examples":[],"full_description":"","see":null,"apis":[{"short_description":"List all environments.","http_method":"GET","api_url":"/api/environments"}],"doc_url":"/apidoc/environments/index","name":"index","formats":[]},{"see_url":null,"params":[{"description":"","allow_nil":false,"required":true,"validator":"Must be String","name":"id","expected_type":"string","full_name":"id"}],"errors":[],"examples":[],"full_description":"","see":null,"apis":[{"short_description":"Show an environment.","http_method":"GET","api_url":"/api/environments/:id"}],"doc_url":"/apidoc/environments/show","name":"show","formats":[]},{"see_url":null,"params":[{"params":[{"description":"","allow_nil":false,"required":true,"validator":"Must be String","name":"name","expected_type":"string","full_name":"environment[name]"}],"description":"","allow_nil":false,"required":true,"validator":"Must be a Hash","name":"environment","expected_type":"hash","full_name":"environment"}],"errors":[],"examples":[],"full_description":"","see":null,"apis":[{"short_description":"Create an environment.","http_method":"POST","api_url":"/api/environments"}],"doc_url":"/apidoc/environments/create","name":"create","formats":[]},{"see_url":null,"params":[{"description":"","allow_nil":false,"required":true,"validator":"Must be String","name":"id","expected_type":"string","full_name":"id"},{"params":[{"description":"","allow_nil":false,"required":false,"validator":"Must be String","name":"name","expected_type":"string","full_name":"environment[name]"}],"description":"","allow_nil":false,"required":true,"validator":"Must be a Hash","name":"environment","expected_type":"hash","full_name":"environment"}],"errors":[],"examples":[],"full_description":"","see":null,"apis":[{"short_description":"Update an environment.","http_method":"PUT","api_url":"/api/environments/:id"}],"doc_url":"/apidoc/environments/update","name":"update","formats":[]},{"see_url":null,"params":[{"description":"","allow_nil":false,"required":true,"validator":"Must be String","name":"id","expected_type":"string","full_name":"id"}],"errors":[],"examples":[],"full_description":"","see":null,"apis":[{"short_description":"Delete an environment.","http_method":"DELETE","api_url":"/api/environments/:id"}],"doc_url":"/apidoc/environments/destroy","name":"destroy","formats":[]}],"full_description":"","short_description":"","doc_url":"/apidoc/environments","name":"Environments","api_url":"/api","formats":[]}}}}