manage_dns()enable_dns()status()status_detail()status_last_updated()last_sync_ts()last_sync_status()last_sync_detail()extensible_attributes()address()name()forwarders()
Infoblox::Grid::MSServer::DNS - Grid Microsoft (r) Server DNS object.
A Grid Microsoft Server DNS object is a single Microsoft DNS server managed by a Grid member.
You can use Infoblox::Grid::MSServer::DNS to configure some of the DNS properties of a Microsoft DNS server, including enabling/disabling the DNS service. The service configurations of a Grid are not inherited by this object.
This section describes all the methods in an Infoblox::Session module that you can apply to a Microsoft Server DNS object.
Use this method to retrieve all the matching objects from the Infoblox appliance. See Infoblox::Session->get() for parameters and return values.
Apply the following attributes to get a specific Grid member object:
address - Optional. A member address or name in FQDN (Fully Qualified Domain Name) format. server_ip - Optional. A member address. server_name - Optional. A member name in FQDN (Fully Qualified Domain Name) format.
my @retrieved_objs = $session->get( object => "Infoblox::Grid::MSServer::DNS", server_ip => "10.0.0.1");
Use this method to modify an object in the Infoblox appliance. See Infoblox::Session->modify() for parameters and return values.
# Use this method to modify the comment of a Grid Microsoft DNS server. $grid_msserver_dns->enable_dns('true'); # Submit modification my $response = $session->modify( $grid_msserver_dns );
Use this method to retrieve all the matching objects from the Infoblox appliance. See Infoblox::Session->search() for parameters and return values.
Apply the following attributes to search for a specific Grid member object:
server_ip - Required. A member address. server_name - Optional. A member name in FQDN (Fully Qualified Domain Name) format.
my @retrieved_objs = $session->search( object => "Infoblox::Grid::MSServer::DNS", server_name => "domain.*");
This section describes all the methods that you can use to configure and retrieve the attribute values of a Grid Microsoft DNS server.
manage_dns()Retrieve or set the managed state of the Microsoft DNS server. When setting the managed state, use true to enable or false to disable synchronization of the DNS server. Setting the status does not stop or start the actual DNS server but controls whether it is synchronized.
Include the specified parameter to set the attribute value. Omit the parameter to retrieve the attribute value.
Specify "true" to set the disable flag or "false" to deactivate/unset it.
If you specified a parameter, the method returns true when the modification succeeds, and returns false when the operation fails.
If you did not specify a parameter, the method returns the attribute value.
#Get manage_dns my $manage_dns = $msserver_dns->manage_dns(); #Modify manage_dns $msserver_dns->manage_dns("true");
enable_dns()Set the DNS service status of the Microsoft DNS server. When setting the service status, use true to enable or false to disable the DNS service on the Microsoft DNS server. Setting the service status stops or starts the actual DNS service. This only applies if manage_dns() is true.
When setting the service status, the Microsoft DNS server will be started or stopped at the next synchronization.
Include the specified parameter to set the attribute value. This setting is read-only. To get the actual status of the service, use the status() method.
Specify "true" to set the disable flag or "false" to deactivate/unset it.
If you specified a parameter, the method returns true when the modification succeeds, and returns false when the operation fails.
If you did not specify a parameter, the method returns the attribute value.
#Get enable_dns my $enable_dns = $msserver_dns->enable_dns(); #Modify enable_dns $msserver_dns->enable_dns("true");
Use this method to enable or disable the synchronization of DNS reporting data for the Microsoft server.
Setting this method to a defined value implicitly sets the override_enable_dns_reports_data_sync method to "true". Setting the parameter to undefined causes the appliance to use the Grid default and automatically resets the override_enable_dns_reports_sync method to "false".
Note that when enable_dns_reports_sync is set to a defined value and override_enable_dns_reports_sync is set to "false", the last operation takes precedence. Thus the sequence $object->enable_dns_reports_sync("false"); $object->override_enable_dns_reports_sync("false"); will set override_enable_dns_reports_sync to "false", and the sequence $object->override_enable_dns_reports_sync("false"); $object->enable_dns_reports_sync("false"); will result in override_enable_dns_reports_sync="true".
Specify "true" to enable the synchronization of DNS reporting data from the Microsoft server. Specify "false" to disable the synchronization of DNS reporting data from the Microsoft server. Default value is "false".
If you specified a parameter, the method returns true when the modification succeeds, and returns false when the operation fails.
If you did not specify a parameter, the method returns the attribute value.
#Get enable_dns_reports_sync my $enable_dns_reports_sync = $msserver_dns->enable_dns_reports_sync(); #Modify enable_dns_reports_sync $msserver_dns->enable_dns_reports_sync("true");
Use this method to enable or disable the monitoring and control of DNS service on Microsoft Server.
Setting this method to a defined value implicitly sets the override_enable_monitoring method to "true". Setting the parameter to undefined causes the appliance to use the grid default and automatically resets the override_enable_monitoring method to "false".
Note that when enable_monitoring is set to a defined value and override_enable_monitoring is set to "false", the last operation takes precedence. Thus the sequence $object->enable_monitoring("true"); $object->override_enable_monitoring("false"); will set override_enable_monitoring to "false", and the sequence $object->override_enable_monitoring("false"); $object->enable_monitoring("true"); will result in override_enable_monitoring="true".
Specify "true" to enable monitoring and control of DNS service on all Microsoft servers in the Grid and "false" to forbid it. Default value is "false".
If you specified a parameter, the method returns true when the modification succeeds, and returns false when the operation fails.
If you did not specify a parameter, the method returns the attribute value.
#Get enable_monitoring value my $enable_monitoring = $msserver_dns->enable_monitoring(); #Modify enable_monitoring value $msserver_dns->enable_monitoring("true");
Use this method to set or retrieve the Microsoft Server DNS login name.
Setting this method to a defined value implicitly sets the override_login method to "true". Setting the parameter to undefined causes the appliance to use the Grid default and automatically resets the override_login attribute to "false".
Note that when login_name is set to a defined value and override_dlogin_name is set to "false", the last operation takes precedence. Thus the sequence $object->login_name('newuser'); $object->override_login("false"); will set override_login to "false", and the sequence $object->override_login("false"); $object->login_name('newuser'); will result in override_login="true".
Include the specified parameter to set the attribute value. Omit the parameter to retrieve the attribute value.
When setting a value that requires a domain name, prepend the domain information followed by a backslash to the username: "domain\username".
The valid value is a string that contains the login name.
If you specified a parameter, the method returns true when the modification succeeds, and returns false when the operation fails.
If you did not specify a parameter, the method returns the attribute value.
#Get login value my $login = $msserver_dns->login_name(); #Modify login value $msserver_dns->login_name("newuser");
Use this method to set a password for the Microsoft Server DNS. This field is used only if the login field for this member is defined. This is a write-only attribute.
This field cannot be retrieved.
The valid value is a string that contains the password.
If you specified a parameter, the method returns true when the modification succeeds, and returns false when the operation fails.
#Set the password $msserver_dns->login_password("iG&ojG97Y");
The override_enable_dns_reports_sync attribute controls whether the enable_dns_reports_sync method values of the Microsoft Server DNS object are used, instead of the Grid default.
The override_enable_dns_reports_sync attribute can be specified explicitly. It is also set implicitly when enable_dns_reports_sync is set to a defined value.
Include the specified parameter to set the attribute value. Omit the parameter to retrieve the attribute value.
Set the parameter to "true" to override the Grid-level setting for enable_dns_reports_sync. Set the parameter to "false" to inherit the Grid-level setting for enable_dns_reports_sync. The default value is "false".
If you specified a parameter, the method returns true when the modification succeeds, and returns false when the operation fails.
If you did not specify a parameter, the method returns the attribute value.
#Get override_enable_dns_reports_sync my $override_enable_dns_reports_sync = $msserver_dns->override_enable_dns_reports_sync(); #Modify override_enable_dns_reports_sync $msserver_dns->override_enable_dns_reports_sync("true");
The override_enable_monitoring attribute controls whether the enable_monitoring method values of the Microsoft Server DNS object are used, instead of the Grid default.
The override_enable_monitoring attribute can be specified explicitly. It is also set implicitly when enable_monitoring is set to a defined value.
Include the specified parameter to set the attribute value. Omit the parameter to retrieve the attribute value.
Set the parameter to "true" to override the Grid-level setting for enable_monitoring. Set the parameter to "false" to inherit the Grid-level setting for enable_monitoring. The default value is "false".
If you specified a parameter, the method returns true when the modification succeeds, and returns false when the operation fails.
If you did not specify a parameter, the method returns the attribute value.
#Get override_enable_monitoring my $override_enable_monitoring = $msserver_dns->override_enable_monitoring(); #Modify override_enable_monitoring $msserver_dns->override_enable_monitoring("true");
The override_login attribute controls whether the login_name method values of the Microsoft Server DNS are used, instead of the Grid default.
The override_login attribute can be specified explicitly. It is also set implicitly when login_name is set to a defined value.
Include the specified parameter to set the attribute value. Omit the parameter to retrieve the attribute value.
Set the parameter to "true" to override the Grid-level setting for login_name. Set the parameter to "false" to inherit the Grid-level setting for login_name. The default value is "false".
If you specified a parameter, the method returns true when the modification succeeds, and returns false when the operation fails.
If you did not specify a parameter, the method returns the attribute value.
#Get override_login my $override_login = $msserver_dns->override_login(); #Modify override_login $msserver_dns->override_login("true");
The override_synchronization_interval attribute controls whether the synchronization_interval method values of the Microsoft Server DNS are used, instead of the Grid default.
The override_synchronization_interval attribute can be specified explicitly. It is also set implicitly when synchronization_interval is set to a defined value.
Include the specified parameter to set the attribute value. Omit the parameter to retrieve the attribute value.
Set the parameter to "true" to override the Grid-level setting for synchronization_interval. Set the parameter to "false" to inherit the Grid-level setting for synchronization_interval. The default value is "false".
If you specified a parameter, the method returns true when the modification succeeds, and returns false when the operation fails.
If you did not specify a parameter, the method returns the attribute value.
#Get override_synchronization_interval my $override_synchronization_interval = $msserver_dns->override_synchronization_interval(); #Modify override_synchronization_interval $msserver_dns->override_synchronization_interval("true");
status()Retrieve the running status of the DNS service of the Microsoft DNS server. Returns a status that is "running", "stopped", or "error". The returned status is the latest known status as of the date returned by the status_last_updated() attribute.
The method returns the attribute value.
#Get status my $status = $msserver_dns->status();
status_detail()Retrieve the detailed running status of the DNS service of the Microsoft DNS server. The returned status is the latest known status.
The method returns the attribute value.
#Get status my $status = $msserver_dns->status();
status_last_updated()Retrieve the time when the DNS service status of the Microsoft DNS server was last updated.
The method returns the attribute value.
#Get status_last_updated my $status_last_updated = $msserver_dns->status_last_updated();
Use this method to set or retrieve the synchronization interval of the Microsoft Server DNS.
Setting this method to a defined value implicitly sets the override_synchronization_interval method to "true". Setting the parameter to undefined causes the appliance to use the Grid default and automatically resets the override_synchronization_interval attribute to "false".
Note that when synchronization_interval is set to a defined value and override_dsynchronization_interval is set to "false", the last operation takes precedence. Thus the sequence $object->synchronization_interval(10); $object->override_synchronization_interval("false"); will set override_synchronization_interval to "false", and the sequence $object->override_synchronization_interval("false"); $object->synchronization_interval(10); will result in override_synchronization_interval="true".
Include the specified parameter to set the attribute value. Omit the parameter to retrieve the attribute value.
The valid value is an unsigned integer.
If you specified a parameter, the method returns true when the modification succeeds, and returns false when the operation fails.
If you did not specify a parameter, the method returns the attribute value.
#Get synchronization_interval value my $synchronization_interval = $msserver_dns->synchronization_interval(); #Modify synchronization_interval value $msserver_dns->synchronization_interval(10);
last_sync_ts()Retrieve the timestamp of the end of the last synchronization attempt related to zone list and DNS properties.
The method returns the attribute value.
#Get last_sync_ts my $last_sync_ts = $msserver_dns->last_sync_ts();
last_sync_status()Retrieve the result of the last synchronization attempt, if last_sync_ts is defined. Valid values are "Ok", "Warning", or "Error".
The method returns the attribute value.
#Get last_sync_status my $last_sync_status = $msserver_dns->last_sync_status();
last_sync_detail()Retrieve the detailed result of the last synchronization attempt, if last_sync_ts is defined.
The method returns the attribute value.
#Get last_sync_detail my $last_sync_detail = $msserver_dns->last_sync_detail();
Use this method to retrieve the extensible attributes associated with a Grid Microsoft DNS Server object. This attribute is read-only and cannot be set.
None.
The method returns the attribute value.
#Get extattrs my $ref_extattrs = $msserver_dns->extattrs();
extensible_attributes()Use this method to retrieve the extensible attributes of the associated Grid Microsoft DNS Server object.
This method is read-only. Use the Infoblox::Grid::MSServer object to set or modify the extensible attributes of the Grid Microsoft DNS Server object.
The method returns the attribute value.
#Get extensible_attributes my $extensible_attributes = $msserver_dns->extensible_attributes();
address()Use this method to retrieve the IP address or FQDN of the associated Grid Microsoft DNS Server object.
This method is read-only. Use the Infoblox::Grid::MSServer object to set or modify the IP address of the Grid Microsoft DNS Server object.
The method returns the attribute value.
#Get address my $address = $msserver_dns->address();
name()Use this method to retrieve the FQDN of the associated Grid Microsoft DNS Server object.
This method is read-only. Use the Infoblox::Grid::MSServer object to set or modify the IP address of the Grid Microsoft DNS Server object.
The method returns the attribute value.
#Get address my $name = $msserver_dns->name();
forwarders()Use this method to specify forwarders for the Microsoft DNS server. A forwarder is essentially a name server to which other name servers first send all of their off-site queries. The forwarder builds up a cache of information, avoiding the need for the other name servers to send queries off-site.
This setting is a per Microsoft DNS server setting. It doesn't override the Grid-level setting and the Grid-level setting does not apply if no value is defined for this Microsoft DNS server.
Include the specified parameter to set the attribute value. Omit the parameter to retrieve the attribute value.
Specify an array of IPV4/IPV6 addresses to set the list of forwarders.
If you specified a parameter, the method returns true when the modification succeeds, and returns false when the operation fails.
If you did not specify a parameter, the method returns the attribute value.
#Get forwarders my $forwarders = $msserver_dns->forwarders(); #Modify forwarders $msserver_dns->forwarders(['10.0.0.1','10.0.0.2']);
Infoblox Inc. http://www.infoblox.com/
Copyright (c) 2017 Infoblox Inc.