Infoblox::DNS::Record::CNAME - DNS CNAME record object.
A CNAME record maps an alias to a canonical name. You can use CNAME records in both forward- and IPv4 reverse-mapping zones to serve two different purposes. (At this time, you cannot use CNAME records with IPv6 reverse-mapping zones.)
Note that you must specify only one view for the attribute "views".
my $bind_cname = Infoblox::DNS::Record::CNAME->new ( canonical => $fqdn, # Required name => $fqdn, # Required comment => $string, # Optional / Default is empty disable => "true"|"false" # Optional / Default "false" extattrs => { $string => $extattr, ... }, # Optional / Default is undefined extensible_attributes => { $string => $string|$num, $string => [ $string|$num, ...], ... }, # Optional / Default is undefined ttl => $num|undef, # Optional / Default is undefined views => [$View1], # Optional / Default is "default" view creator => "DYNAMIC" | "STATIC", # Optional / Default is "STATIC" ddns_protected => "true" | "false", # Optional / Default is "false" ddns_principal => $string, # Optional / Default is undefined forbid_reclamation => "true" | "false", # Optional / Default is "false" );
You cannot set both extattrs and extensible_attributes attributes at the same time.
This section describes all the methods in Infoblox::Session module that you can apply to a CNAME record object.
Use this method to add an object to the Infoblox appliance. See Infoblox::Session->add() for parameters and return values.
#Construct an object my $bind_cname = Infoblox::DNS::Record::CNAME->new ( name => "bind_cname.domain.com", canonical => "cname.domain.com", comment => "this is a demo bind_cname record", disable => "true", ttl => "33", views => [$view1] ); # Submit for addition my $response = $session->add( $bind_cname );
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 DNS CNAME object:
name - Optional. A host name in string format. view - Optional. The DNS view in which the CNAME record is located. By default, all DNS views are searched. But if you omit this attribute and specify a zone, the appliance searches the 'default' view only. zone - Optional. A zone name in FQDN format. canonical - Optional. A canonical name. creator - Optional. Record creator. ddns_principal - Optional. GSS-TSIG principal that owns the record. reclaimable - Optional. The flag that indicates whether the record is reclaimable or not. extattrs - Optional. A hash reference containing extensible attributes. extensible_attributes - Optional. A hash reference containing extensible attributes.
my @retrieved_objs = $session->get( object => "Infoblox::DNS::Record::CNAME", name => "bind_cname.domain.com", view => "default" );
# get all DNS CNAME record in zone "domain.com" of default view my @retrieved_objs = $session->get( object => "Infoblox::DNS::Record::CNAME", zone => "domain.com", view => "default" );
# get DNS CNAME record with canonical name "cname.domain.com" of default view my @retrieved_objs = $session->get( object => "Infoblox::DNS::Record::CNAME", canonical => "cname.domain.com", view => "default" );
# get all DNS CNAME record with a given extensible attribute my @retrieved_objs = $session->get( object => "Infoblox::DNS::Record::CNAME", extensible_attributes => { 'Site' => 'Santa Clara' });
Use this method to modify an object in the Infoblox appliance. See Infoblox::Session->modify() for parameters and return values.
# Use method to modify the comment. $bind_cname->comment("this is a modified comment"); # Submit modification my $response = $session->modify( $bind_cname );
Use this method to remove an object from the Infoblox appliance. See Infoblox::Session->remove() for parameters and return values.
To remove a specific object, first use get() or search() to retrieve the specific object, and then submit this object for removal.
#Get the objects with the same name my @retrieved_objs = $session->get( object => "Infoblox::DNS::Record::CNAME", name => "bind_cname.domain.com", view => "default"); #Find the desired object from the retrieved list. my $desired_cname = $retrieved_objs[0]; # Submit for removal my $response = $session->remove( $desired_cname );
Use this method to search for DNS CNAME record objects in the Infoblox appliance. See Infoblox::Session->search() for parameters and return values.
Apply the following attributes to search for a specific DNS CNAME object.
name - Optional. A host name in string format (regular expression). view - Optional. The DNS view in which the CNAME record is located. By default, all DNS views are searched. But if you omit this attribute and specify a zone, the appliance searches the 'default' view only. zone - Optional. A zone name in FQDN format. canonical - Optional. A canonical name (regular expression). comment - Optional. A comment in string format (regular expression). creator - Optional. Record creator. ddns_principal - Optional. GSS-TSIG principal that owns the record. reclaimable - Optional. The flag that indicates whether the record is reclaimable or not. extattrs - Optional. A hash reference containing extensible attributes. extensible_attributes - Optional. A hash reference containing extensible attributes.
For more information about searching extensible attributes, see Infoblox::Grid::ExtensibleAttributeDef/Searching Extensible Attributes.
# search for all DNS CNAME objects that match "domain.com" in the default DNS view my @retrieved_objs = $session->search( object => "Infoblox::DNS::Record::CNAME", name => 'domain\.com', view => "default", comment => "this is a modified comment" );
# search for all DNS CNAME record in zone "domain.com" of default view my @retrieved_objs = $session->search( object => "Infoblox::DNS::Record::CNAME", zone => "domain.com", view => "default" );
# search DNS CNAME record with canonical name "cname.domain.com" of default view my @retrieved_objs = $session->search( object => "Infoblox::DNS::Record::CNAME", canonical => "cname.domain.com", view => "default" );
# search all DNS CNAME recods with the extensible attribute 'Site' my @retrieved_objs = $session->search( object => "Infoblox::DNS::Record::CNAME", extensible_attributes => { 'Site' => 'Santa Clara' });
This section describes all the methods that you can use to configure and retrieve the attribute values of a CNAME record.
Use this method to set or retrieve the canonical (or official) name of the host.
Include the specified parameter to set the attribute value. Omit the parameter to retrieve the attribute value.
The attribute value can be in unicode format.
Canonical name in FQDN (Fully Qualified Domain Name) format. The FQDN consists of the hostname followed by the domain name (example: abc.com). A hostname can have a maximum of 256 bytes.
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 canonical my $canonical = $bind_cname->canonical(); #Modify canonical name $bind_cname->canonical("bind_cname.domain.com");
Use this method to set or retrieve the descriptive comment.
Include the specified parameter to set the attribute value. Omit the parameter to retrieve the attribute value.
Desired comment in string format with a maximum of 256 bytes.
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 comment my $comment = $bind_cname->comment(); #Modify comment $bind_cname->comment("Modifying the DNS CNAME comment");
Use this method to retrieve cloud API related information for the Infoblox::DNS::Record::CNAME object.
None
The method returns the attribute value.
# Get cloud_info my $cloud_info = $object->cloud_info();
Use this method to set or retrieve the record creator.
Note that changing creator from or to 'SYSTEM' value is not allowed.
Include the specified parameter to set the attribute value. Omit the parameter to retrieve the attribute value.
The valid values are 'STATIC' and 'DYNAMIC'. The default value is 'STATIC'.
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 creator value my $creator = $object->creator();
#Modify creator value $object->creator("DYNAMIC");
Use this method to retrieve the creation time for the record. This is a read-only attribute.
None
The valid return value is a number of seconds that have elapsed since January 1st, 1970 UTC.
#Get creation_time value my $creation_time = $object->creation_time();
Use this method to set or retrive the GSS-TSIG principal that owns this record.
Note that you cannot set ddns_principal for 'STATIC' and 'SYSTEM' records.
Include the specified parameter to set the attribute value. Omit the parameter to retrieve the attribute value.
The GSS-TSIG principal FQDN (Fully Qualified Domain Name) format. The FQDN consists of the hostname followed by the domain name (example: abc.com). A hostname can have a maximum of 256 characters.
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_principal value my $ddns_principal = $object->ddns_principal();
#Modify ddns_principal value $object->ddns_principal('foo.com');
Use this method to set or retrieve the flag that indicates whether DDNS updates for this record are allowed or not.
Include the specified parameter to set the attribute value. Omit the parameter to retrieve the attribute value.
Specify 'true' to protect record from DDNS updates and 'false' to allow DDNS updates for the specified record.
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_protected value my $ddns_protected = $object->ddns_protected();
#Modify ddns_protected value $object->ddns_protected('true');
Use this method to set or retrieve the disable flag of a DNS record.
Include the specified parameter to set the attribute value. Omit the parameter to retrieve the attribute value.
The default value for this field is false. The DNS record is enabled.
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 disable my $disable = $bind_cname->disable(); #Modify disable $bind_cname->disable("true");
Use this method to retrieve the host name in punycode format. This is a read-only attribute.
None
The method returns the attribute value.
# Get attribute value my $value = $bind_cname->dns_name();
Use this method to retrieve the canonical (or official) name, in punycode format, of the host. This is a read-only attribute.
None
The method returns the attribute value.
# Get attribute value my $value = $bind_cname->dns_canonical();
Use this method to set or retrieve the extensible attributes associated with a DNS CNAME record object.
Valid value is a hash reference containing the names of extensible attributes and their associated values ( Infoblox::Grid::Extattr objects ).
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 extattrs my $ref_extattrs = $bind_cname->extattrs(); #Modify extattrs $bind_cname->extattrs({ 'Site' => $extattr1, 'Administrator' => $extattr2 });
Use this method to set or retrieve the extensible attributes associated with a DNS CNAME record.
Include the specified parameter to set the attribute value. Omit the parameter to retrieve the attribute value.
For valid values for extensible attributes, see Infoblox::Grid::ExtensibleAttributeDef/Extensible Attribute Values.
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 extensible attributes my $ref_extensible_attributes = $bind_cname->extensible_attributes(); #Modify extensible attributes $bind_cname->extensible_attributes({ 'Site' => 'Santa Clara', 'Administrator' => [ 'Peter', 'Tom' ] });
Use this method to set or retrieve the flag that indicates whether the reclamation is allowed for the record or not.
Include the specified parameter to set the attribute value. Omit the parameter to retrieve the attribute value.
Specify 'true' to forbid reclamation for the record and 'false' to allow it. 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 forbid_reclamation my $forbid_reclamation = $object->forbid_reclamation(); #Modify forbid_reclamation $object->forbid_reclamation('true');
Use this method to retrieve the time when the associated record was last queried. This is a read-only attribute.
None
The method returns the attribute value. The number of seconds that have elapsed since January 1st, 1970 UTC.
#Get last_queried my $last_queried = $bind_cname->last_queried();
Use this method to set or retrieve the host name.
Include the specified parameter to set the attribute value. Omit the parameter to retrieve the attribute value.
The attribute value can be in unicode format.
A name in FQDN (Fully Qualified Domain Name) format. The FQDN consists of the host_name followed by the domain name (example: abc.com). A host_name can have a maximum of 256 bytes.
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 name my $name = $bind_cname->name(); #Modify name $bind_cname->name("bind_cname2.domain.com");
Use this method to retrieve the flag that indicates whether the record is reclaimable or not.
None
The method returns the attribute value.
#Get reclaimable my $reclaimable = $object->reclaimable();
Use this method to set or retrieve the Time to Live (TTL) value.
Include the specified parameter to set the attribute value. Omit the parameter to retrieve the attribute value.
The default value is undefined which indicates that the record inherits the TTL value of the zone.
Specify a TTL value to override the TTL value at the zone level.
A 32-bit integer (range from 0 to 4294967295) that represents the duration, in seconds, that the record is cached. Zero indicates that the record should not be cached.
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 ttl my $ttl = $bind_cname->ttl(); #Modify ttl $bind_cname->ttl(1800); #Un-override ttl $bind_cname->ttl(undef);
Use this method to set or retrieve the view of the CNAME record.
Include the specified parameter to set the attribute value. Omit the parameter to retrieve the attribute value.
The default value is the "default" view, which means the CNAME record is located under the default view.
Array reference of defined Infoblox::DNS::View objects.
Note that the array size must be 1.
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 views my $ref_views = $bind_cname->views(); #Modify views, list of Infoblox::DNS::View objects $bind_cname->views([$view1]);
Use this method to retrieve the zone name of a DNS CNAME record. This method is read-only and cannot be set.
None
Returns the attribute value.
# Get zone my $zone = $bind_cname->zone();
The following sample code demonstrates the different functions that can be applied to an object, such as add, search, modify, and remove. This sample code also includes error handling for the operations.
#Preparation prior to a DNS CNAME record insertion
#PROGRAM STARTS: Include all the modules that will be used use strict; use Infoblox;
#Create a session to the Infoblox appliance my $session = Infoblox::Session->new( master => "192.168.1.2", username => "admin", password => "infoblox" ); unless ($session) { die("Construct session failed: ", Infoblox::status_code() . ":" . Infoblox::status_detail()); } print "Session created successfully\n";
#Create the zone prior to a CNAME record insertion my $zone = Infoblox::DNS::Zone->new(name => "domain.com"); unless ($zone) { die("Construct zone failed: ", Infoblox::status_code() . ":" . Infoblox::status_detail()); } print "Zone object created successfully\n";
#Verify if the zone exists my $object = $session->get(object => "Infoblox::DNS::Zone", name => "domain.com"); unless ($object) { print "Zone does not exist on server, safe to add the zone\n"; $session->add($zone) or die("Add zone failed: ", $session->status_code() . ":" . $session->status_detail()); } print "Zone added successfully\n";
#Create a DNS CNAME record
my $view1 = Infoblox::DNS::View->new( name => "default" );
#Construct a DNS CNAME object my $bind_cname = Infoblox::DNS::Record::CNAME->new( name => "bind_cname.domain.com", canonical => "cname.domain.com", comment => "this is a demo bind_cname record", ttl => "33", views => [$view1]); unless ($bind_cname) { die("Construct DNS record CNAME failed: ", Infoblox::status_code() . ":" . Infoblox::status_detail()); } print "DNS CNAME object created successfully\n";
#Add the DNS CNAME record object to the Infoblox appliance through a session $session->add($bind_cname) or die("Add record cname failed: ", $session->status_code() . ":" . $session->status_detail()); print "DNS CNAME object added to server successfully\n";
#Search for a specific DNS CNAME record
#Search all CNAME records that match "domain.com" my @retrieved_objs = $session->search( object => "Infoblox::DNS::Record::CNAME", name => 'domain\.com' ); my $object = $retrieved_objs[0]; unless ($object) { die("Search record CNAME failed: ", $session->status_code() . ":" . $session->status_detail()); } print "Search DNS CNAME object found at least 1 matching entry\n";
#Search all CNAME records that start with "bind" and end with ".domain.com" my @retrieved_objs = $session->search( object => "Infoblox::DNS::Record::CNAME", name => '^bind.*\.domain\.com\$' ); my $object = $retrieved_objs[0]; unless ($object) { die("Search record CNAME failed: ", $session->status_code() . ":" . $session->status_detail()); } print "Search DNS CNAME object using regexp found at least 1 matching entry\n";
#Get and modify a DNS CNAME record
#Get CNAME record through the session my @retrieved_objs = $session->get( object => "Infoblox::DNS::Record::CNAME", name => "bind_cname.domain.com", view => "default" ); my $object = $retrieved_objs[0]; unless ($object) { die("Get record CNAME failed: ", $session->status_code() . ":" . $session->status_detail()); } print "Get DNS CNAME object found at least 1 matching entry\n";
#Modify one of the attributes of the specified CNAME record $object->disable("true");
#Apply the changes $session->modify($object) or die("Modify record CNAME failed: ", $session->status_code() . ":" . $session->status_detail()); print "DNS CNAME object modified successfully \n";
#Remove a DNS CNAME record
#Get CNAME record through the session my @retrieved_objs = $session->get( object => "Infoblox::DNS::Record::CNAME", name => "bind_cname.domain.com", view => "default" ); $object = $retrieved_objs[0]; unless ($object) { die("Get record CNAME failed: ", $session->status_code() . ":" . $session->status_detail()); } print "Get DNS CNAME object found at least 1 matching entry\n";
#Submit the object for removal $session->remove( $object ) or die("Remove record CNAME failed: ", $session->status_code() . ":" . $session->status_detail()); print "DNS CNAME object removed successfully \n";
####PROGRAM ENDS####
Infoblox Inc. http://www.infoblox.com/
Infoblox::DNS::View, Infoblox::DNS::Zone, Infoblox::Session, Infoblox::Session->get(), Infoblox::Session->search(), Infoblox::Session->add(), Infoblox::Session->remove(), Infoblox::Session->modify()
Copyright (c) 2017 Infoblox Inc.