manage_dhcp()enable_dhcp()status()status_detail()status_last_updated()last_sync_ts()last_sync_status()last_sync_detail()extensible_attributes()address()broadcast_address()enable_ddns()ddns_server_always_updates()comment()read_only()name()static_hosts()dynamic_hosts()dhcp_utilization()dhcp_utilization_status()
Infoblox::Grid::MSServer::DHCP - Grid Microsoft (r) Server DHCP object.
You can use Infoblox::Grid::MSServer::DHCP to configure some of the DHCP properties of a Microsoft DHCP server, including enabling/disabling the DHCP 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 DHCP 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 - Required. A Microsoft server address or name in FQDN (Fully Qualified Domain Name) format.
my @retrieved_objs = $session->get( object => "Infoblox::Grid::MSServer::DHCP", address => "10.0.0.1");
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:
address - Required. A Microsoft server address or name in FQDN (Fully Qualified Domain Name) format. (Regular expressions are supported)
my @retrieved_objs = $session->search( object => "Infoblox::Grid::MSServer::DHCP", address => "domain.*");
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 a field of a grid Microsoft DHCP server. $grid_msserver_dhcp->enable_dhcp('true'); # Submit modification my $response = $session->modify( $grid_msserver_dhcp );
This section describes all the methods that you can use to configure and retrieve the attribute values of a grid Microsoft DHCP server.
manage_dhcp()Retrieve or set the managed state of the Microsoft DHCP server. When setting the managed state, use true to enable or false to disable synchronization of the DHCP server. Setting the status does not stop or start the actual DHCP 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_dhcp my $manage_dhcp = $msserver_dhcp->manage_dhcp(); #Modify manage_dhcp $msserver_dhcp->manage_dhcp("true");
enable_dhcp()Set the DHCP service status of the Microsoft DHCP server. When setting the service status, use true to enable or false to disable the DHCP service on the Microsoft DHCP server. Setting the service status stops or starts the actual DHCP service. This only applies if manage_dhcp() is true.
When setting the service status, the Microsoft DHCP server will be started or stopped at the next synchronization.
Include the specified parameter to set the attribute value. This setting is write-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_dhcp my $enable_dhcp = $msserver_dhcp->enable_dhcp(); #Modify enable_dhcp $msserver_dhcp->enable_dhcp("true");
status()Retrieve the running status of the DHCP service of the Microsoft DHCP server. The running status 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_dhcp->status();
status_detail()Retrieve the detailed running status of the DHCP service of the Microsoft DHCP server. The returned status is the latest known status.
The method returns the attribute value.
#Get status my $status = $msserver_dhcp->status();
status_last_updated()Retrieve the time when the DHCP service status of the Microsoft DHCP server was last updated.
The method returns the attribute value.
#Get status_last_updated my $status_last_updated = $msserver_dhcp->status_last_updated();
last_sync_ts()Retrieve the timestamp of the end of the last synchronization attempt related to all DHCP data, except leases.
The method returns the attribute value.
#Get last_sync_ts my $last_sync_ts = $msserver_dhcp->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_dhcp->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_dhcp->last_sync_detail();
Use this method to set or retrieve the Microsoft Server DHCP 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_dhcp->login_name(); #Modify login value $msserver_dhcp->login_name("newuser");
Use this method to set a password for the Microsoft Server DHCP. 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_dhcp->login_password("iG&ojG97Y");
Use this method to retrieve the extensible attributes associated with a Grid Microsoft DHCP Server object. This attribute is read-only and cannot be set.
None.
The method returns the attribute value.
#Get extattrs my $ref_extattrs = $msserver_dhcp->extattrs();
extensible_attributes()Use this method to retrieve the extensible attributes of the associated Grid Microsoft DHCP Server object.
This method is read-only. Use the Infoblox::Grid::MSServer object to set or modify the extensible attributes of the Grid Microsoft DHCP Server object.
The method returns the attribute value.
#Get extensible_attributes my $extensible_attributes = $msserver_dhcp->extensible_attributes();
address()Use this method to retrieve the IP address or FQDN of the associated Grid Microsoft DHCP Server object.
This method is read-only. Use the Infoblox::Grid::MSServer object to set or modify the Grid Microsoft DHCP Server object address.
The method returns the attribute value.
#Get address my $address = $msserver_dhcp->address();
broadcast_address()Use this method to set or retrieve the broadcast address of the associated Grid Microsoft DHCP Server object.
Include the specified parameter to set the attribute value. Omit the parameter to retrieve the attribute value.
The Microsoft DHCP server broadcast address in IPV4 format.
#Get address my $address = $msserver_dhcp->broadcast_address(); #Modify broadcast_address $msserver_dhcp->broadcast_address("10.0.0.1");
enable_ddns()Retrieve or set the dynamic DNS flag of the Microsoft DHCP server.
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 enable_ddns my $enable_ddns = $msserver_dhcp->enable_ddns(); #Modify enable_ddns $msserver_dhcp->enable_ddns("true");
Use this method to allow invalid MAC address synchronization in DHCP leases and fixed addresses.
Setting this method to a defined value implicitly sets the override_enable_invalid_mac method to "true". Setting the parameter to undefined causes the appliance to use the grid default and automatically resets the override_enable_invalid_mac method to "false".
Note that when enable_invalid_mac is set to a defined value and override_enable_invalid_mac is set to "false", the last operation takes precedence. Thus the sequence $object->enable_invalid_mac("true"); $object->override_enable_invalid_mac("false"); will set override_enable_invalid_mac to "false", and the sequence $object->override_enable_invalid_mac("false"); $object->enable_invalid_mac("true"); will result in override_enable_invalid_mac="true".
Specify "true" to allow invalid MAC address synchronization or "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_invalid_mac value my $enable_invalid_mac = $msserver_dhcp->enable_invalid_mac(); #Modify enable_invalid_mac value $msserver_dhcp->enable_invalid_mac("true");
Use this method to enable or disable the monitoring and control of DHCP service.
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 allow invalid mac address synchronization or "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_dhcp->enable_dhcp_monitoring(); #Modify enable_monitoring value $msserver_dhcp->enable_monitoring("true");
ddns_server_always_updates()Retrieve or set the "Always update DDNS" flag of the Microsoft DHCP server. Use "true" to always allow dynamic DNS updates, or use "false" to only update when requested by the client. The default value is "false".
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 ddns_server_always_updates my $ddns_server_always_updates = $msserver_dhcp->ddns_server_always_updates(); #Modify ddns_server_always_updates $msserver_dhcp->ddns_server_always_updates("true");
Use this method to set or retrieve the custom DHCP options that are associated with the specified Microsoft DHCP server.
Note: You can set only options that are included in both the Microsoft server and NIOS predefined option definitions. Options that are not common to both are read-only and cannot be modified.
Include the specified parameter to set the attribute value. Omit the parameter to retrieve the attribute value.
The valid value is an array reference that contains defined Infoblox::DHCP::MSOption objects. The default value is empty.
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 options my $ref_options = $msserver_dhcp->ms_options(); #Modify options $msserver_dhcp->ms_options([$option12]); #$option12 is an Infoblox::DHCP::MSOption object
comment()Use this method to retrieve the comment associated with the Grid Microsoft DHCP Server object.
This method is read-only. Use the Infoblox::Grid::MSServer object to set or modify the Grid Microsoft DHCP Server object comment.
The method returns the attribute value.
#Get comment my $comment = $msserver_dhcp->comment();
read_only()Use this method to retrieve the read_only flag of the associated Grid Microsoft DHCP Server object.
This method is read-only. Use the Infoblox::Grid::MSServer object to set or modify the Grid Microsoft DHCP Server object read_only status.
The method returns the attribute value.
#Get read_only my $read_only = $msserver_dhcp->read_only();
name()Use this method to retrieve the name of the associated Grid Microsoft DHCP Server object.
This method is read-only. Use the Infoblox::Grid::MSServer object to set or modify the Grid Microsoft DHCP Server object name.
The method returns the attribute value.
#Get name my $name = $msserver_dhcp->name();
static_hosts()Use this method to retrieve the number of static addresses (fixed addresses and reservations) associated with the Microsoft server.
The method returns the attribute value.
#Get static_hosts my $static_hosts = $msserver_dhcp->static_hosts();
Use this method to retrieve the flag used to indicate whether DHCP supports failover. This is a read-only attribute.
None
The method returns the attribute value.
#Get supports_failover value my $supports_failover = msserver_dhcp->supports_failover();
dynamic_hosts()Use this method to retrieve the number of active leases associated with the Microsoft server.
The method returns the attribute value.
#Get dynamic_hosts my $dynamic_hosts = $msserver_dhcp->dynamic_hosts();
dhcp_utilization()Use this method to retrieve the DHCP utilization status of the Microsoft server. The returned value is between 0 and 1000. 1000 indicates 100% utilization.
The method returns the attribute value.
#Get dhcp_utilization my $dhcp_utilization = $msserver_dhcp->dhcp_utilization();
dhcp_utilization_status()Use this method to retrieve the DHCP utilization status of the Microsoft server. The returned value is 'Low', 'Normal', 'High', or 'Full', and depend on the value of the low- and high-water mark parameters.
The method returns the attribute value.
#Get dhcp_utilization_status my $dhcp_utilization_status = $msserver_dhcp->dhcp_utilization_status();
The override_enable_invalid_mac attribute controls whether the enable_invalid_mac method values of the Microsoft Server DHCP object are used, instead of the Grid default.
The override_enable_invalid_mac attribute can be specified explicitly. It is also set implicitly when enable_invalid_mac 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_invalid_mac. Set the parameter to "false" to inherit the grid-level setting for enable_invalid_mac. 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_invalid_mac my $override_enable_invalid_mac = $msserver_dhcp->override_enable_invalid_mac(); #Modify override_enable_invalid_mac $msserver_dhcp->override_enable_invalid_mac("true");
The override_enable_monitoring attribute controls whether the enable_monitoring method values of the Microsoft Server DHCP 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_dhcp->override_enable_monitoring(); #Modify override_enable_monitoring $msserver_dhcp->override_enable_monitoring("true");
The override_login attribute controls whether the login_name method values of the Microsoft Server DHCP 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_dhcp->override_login(); #Modify override_login $msserver_dhcp->override_login("true");
The override_synchronization_interval attribute controls whether the synchronization_interval method values of the Microsoft Server DHCP 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_dhcp->override_synchronization_interval(); #Modify override_synchronization_interval $msserver_dhcp->override_synchronization_interval("true");
Use this method to set or retrieve the synchronization interval of the Microsoft Server DHCP.
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_dhcp->synchronization_interval(); #Modify synchronization_interval value $msserver_dhcp->synchronization_interval(10);
Infoblox Inc. http://www.infoblox.com/
Infoblox::Grid::MSServer, Infoblox::DHCP::MSOption
Copyright (c) 2017 Infoblox Inc.