hosts (IPAM)

Mandatory parameters are denoted by an * (asterisk).

header	type	description	required	encoding	sample	object_headers

header	type	description	required	encoding	object_headers
HEADER-ipamdhcp-v2-ipamhost*	string	The primary identifier of the header stating the type of object.	TRUE	string
key*	string	The primary identifier of an individual object. For ipam-hosts, UUID of IPAM Host is used as the key. Example: 515fb3ce-c2a2-11ed-9fba-4ef7190b122e	TRUE	string
name*	string	The name of the IPAM host. May contain 1 to 256 characters. May include UTF-8.	TRUE	string
comment	string	The description of the IPAM host. May contain 0 to 1024 characters. May include UTF-8.	FALSE	string
auto_generate_records	boolean	Specifies whether resource records are to be auto-generated for the host.	FALSE	string
host_names	array	The name records to be generated for the host. This field is required if auto_generate_records is "true".	FALSE	nios	iphoit_name	iphoit_primary_name	iphoit_alias	iphoit_zone
addresses*	array	The list of all IP addresses associated with the IPAM host, which may be in different IP spaces.	TRUE	stringarray

New IPAM hosts cannot be added using the import feature. However, existing IPAM hosts can be updated. For adding an IPAM host, make sure the key field is not blank. For updating the IPAM host, the key field in the CSV file must exactly match the key field of the host to be updated. The Key field corresponds to the OPHID. Click an on-prem host in the Cloud Services Portal. The OPHID is displayed in the info pane.