Infoblox::DTC::Query::Parameters - A DTC query call parameters object.


NAME

Infoblox::DTC::Query::Parameters - A DTC query call parameters object.


DESCRIPTION

A DTC query call parameters object.


CONSTRUCTOR

 my $params = Infoblox::DTC::Query::Parameters->new(
     address => $string,                          # Required
     qname   => $string,                          # Required
     type    => 'A' | 'AAAA' | 'NAPTR' | 'CNAME', # Required
     lbdn    => $lbdn,                            # Required
     member  => $string,                          # Required
 );


SESSION METHODS

The object does not support any session methods. It's used as a parameters for a DTC query call.


MODULE METHODS


Infoblox::DTC->query( )

Use this method to perform a DTC query on a given member.

Parameter

Valid value is an Infoblox::DTC::Query::Parameters object.

Returns

The method returns an Infoblox::DTC::Query::Response when operation succeeds, and returns 'false' when the operation fails.

Example
 #perform DTC query
 my $response = $dtc->query($params);


METHODS

This section describes all the methods that you can use to set or retrieve the attribute values of the object.

address( )

Use this method to set or retrieve an ostensible IPv4 or IPv6 source address.

Include the specified parameter to set the attribute value. Omit the parameter to retrieve the attribute value.

Parameter

The valid value is a string that contains an IPv4 or IPv6 address.

Returns

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.

Example
 #get address value
 my $address = $params->address();
 #modify address value
 $params->address('192.168.1.0');

lbdn( )

Use this method to set or retrieve a specific LBDN object for querying.

Note that LBDN objects must be first retrieved using the get() or search() operation.

Include the specified parameter to set the attribute value. Omit the parameter to retrieve the attribute value.

Parameter

The valid value is an Infoblox::DTC::LBDN object.

Returns

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.

Example
 #get lbdn value
 my $lbdn = $params->lbdn();
 #modify lbdn value
 $params->lbdn($lbdn);

member( )

Use this method to set or retrieve a member name for querying.

Include the specified parameter to set the attribute value. Omit the parameter to retrieve the attribute value.

Parameter

The valid value is a string that contains the member name.

Returns

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.

Example
 #get member value
 my $member = $params->member();
 #modify member value
 $params->member('localhost.localdomain');

qname( )

Use this method to set or retrieve a fully-qualified DNS query name.

Include the specified parameter to set the attribute value. Omit the parameter to retrieve the attribute value.

Parameter

The valid value is a string, which contains a query name in FQDN format.

Returns

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.

Example
 #get qname value
 my $qname = $params->qname();
 #modify qname value
 $params->qname($fqdn);

type( )

Use this method to set or retrieve the type of desired results.

Include the specified parameter to set the attribute value. Omit the parameter to retrieve the attribute value.

Parameter

The valid values are 'A', 'AAAA', 'CNAME' and 'NAPTR'.

Returns

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.

Example
 #get type value
 my $type = $params->type();
 #modify type value
 $params->type('AAAA');


AUTHOR

Infoblox Inc. http://www.infoblox.com/


SEE ALSO

Infoblox::DTC->query()


COPYRIGHT

Copyright (c) 2017 Infoblox Inc.