/
Supported Fields

Supported Fields

The following table contains the fields that are in the NetMRI and Sandbox configuration file and are shared when a NetMRI or Sandbox VM instance is deployed. The required fields are marked with an asterisk “*”.

Field

Member

Description

Field

Member

Description

#infoblox-config

 

This tag is used to mark the beginning of the YAML configuration block.

default_admin_password

 

It refers to the initial password assigned to either the NetMRI admin or the sbuser (Sandbox user) accounts. This password serves as the default login credential for accessing the NetMRI system.

server_name

 

The hostname assigned to the NetMRI server.

db_name

 

NetMRI database name.

role

 

“oc” or “standalone”. The case is irrelevant. See the Note in the section above for additional information.

mgmt_port*

 

It refers to the management port assigned to the NetMRI or the Sandbox environment.

 

v4_addr

IPv4 address for the management port.

 

v4_netmask

IPv4 subnet mask for the management port.

 

v4_gw

IPv4 gateway for the management port.

 

v6_addr

IPv6 address for the management port.

 

v6_prefix

IPv6 prefix for the management port.

 

v6_gw

IPv6 default gateway for the management port.

 

v4_use_dhcp

Use the existing configured IPv4 settings obtained through DHCP.

 

v6_use_dhcp

Use the existing configured IPv6 settings obtained through DHCP.

 

primary_dns_server

The initial DNS server.

 

secondary_dns_server

The secondary or alternative DNS server.

 

search_domains

This field specifies a collection of DNS domains in the form of a list.

scan_port

 

 

 

v4_addr

IPv4 address for the scan port.

 

v4_netmask

IPv4 subnet mask for the scan port.

 

v4_gw

IPv4 gateway for the scan port.

 

v6_addr

IPv6 address for the scan port.

 

v6_prefix

IPv6 prefix for the scan port.

 

v6_gw

IPv6 default gateway for the scan port.

 

primary_dns_server

The initial DNS server.

 

secondary_dns_server

The secondary or alternative DNS server.

 

search_domains

This field specifies a collection of DNS domains in the form of a list.

time*

 

This field includes timezone and NTP server configuration.

 

server_1

This field specifies a primary NTP server.

 

timezone

This field defines the specific timezone configuration for a server.

Note: If you specify a time zone, the region is not required. For example, if you specify “GMT +3” for the time zone, you do not need to specify “Europe” for the region.

In addition to the fields listed above that are shared by both NetMRI and Sandbox VM instances, NetMRI has the following additional fields:

db_name

 

The name of the database used by NetMRI.

scan_port

 

This field is used to configure a scanning port. It shares the common attributes with the mgmt_port configuration, except for the inclusion of v4_use_dhcp and v6_use_dhcp.

Additional considerations:

  • If the v4_use_dhcp option is selected, the remaining v4_* fields will be ignored. 

  • If the v6_use_dhcp option is selected, the remaining v6_* fields will be ignored.

  • If v4_use_dhcp or v6_use_dhcp is used and the link-local IP address (169.254.0.0/16 or fe80::/10) is assigned to interfaces, the _dhcp option and the IP address will be ignored, and the configuration will fail.

  • The MGMT configuration with IPv4 and DNS settings as well as the TIME configuration are required fields; if any one of them is left blank, the configuration will fail. 

    • If the v4_* fields are present or v4_use_dhcp is present, the MGMT IP configuration will be valid.

    • If at least one DNS server and at least one DNS domain are specified, the MGMT DNS configuration will be valid.

    • The TIME configuration requires fields for both the time server and time zone.

Note

* This field is applicable for both Sandbox and NetMRI.