Infoblox::DXL::Endpoint::Broker - A Data Exchange Layer (DXL) endpoint broker object.
DXL brokers are installed on managed systems for routing messages between connected clients. The network of brokers tracks active consumers and dynamically adjusts the message routing as needed. When a client requests a service or when an update is broadcasted, brokers relay these messages.
The DXL endpoint broker is used to configure DXL broker for a particular endpoint.
my $object = Infoblox::DXL::Endpoint::Broker->new( host_name => $fqdn, #Required address => $ipaddr, #Optional / Default is undefined port => $uint, #Optional / Default is 8883 unique_id => $string, #Optional / Default is undefined );
The object does not support any session methods.
This section describes all the functions that you can apply to a DXL Broker object.
Use this method to set or retrieve the list of DXL brokers for the DXL endpoint. See Infoblox::DXL::Endpoint->brokers() for parameters and return values.
#Get brokers value my $brokers = $object->brokers();
#Construct Infoblox::DXL::Endpoint::Broker object my $broker = Infoblox::DXL::Endpoint::Broker->new( host_name => 'dxl-br.localdomain', );
#Modify brokers value $object->brokers([$broker]);
This section describes all the methods that you can use to set or retrieve the attribute values of the object.
Use this method to set or retrieve the DXL broker IP address.
Include the specified parameter to set the attribute value. Omit the parameter to retrieve the attribute value.
The valid value is an IP address in string format.
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 address value my $value = $object->address();
#Modify address value $object->address('1.1.1.1');
Use this method to set or retrieve the host name for the DXL broker.
Include the specified parameter to set the attribute value. Omit the parameter to retrieve the attribute value.
The valid value is a desired FQDN in string format.
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 host_name value my $value = $object->host_name();
#Modify host_name value $object->host_name('dxl-broker.localdomain');
Use this method to set or retrieve the port number for the DXL broker communication.
Include the specified parameter to set the attribute value. Omit the parameter to retrieve the attribute value.
The valid value is an unsigned integer between 1 and 65535. The default value is 8883.
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 port value my $value = $object->port();
#Modify port value $object->port('1312');
Use this method to set or retrieve the unique ID for the DXL broker.
Include the specified parameter to set the attribute value. Omit the parameter to retrieve the attribute value.
The valid value is a desired ID in string format.
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 unique_id value my $value = $object->unique_id();
#Modify unique_id value $object->unique_id('5d73b77f-8c4b-4ae0-b437-febd12facfd4');
Infoblox Inc. http://www.infoblox.com/
Infoblox::DXL::Endpoint, Infoblox::DXL::Endpoint->brokers().
Copyright (c) 2017 Infoblox Inc.