Infoblox::Grid::DNS::FileTransferSetting - A DNS traffic capture file transfer setting object.
The DNS traffic capture file transfer setting object provides information and configuration for captured DNS traffic transfer to a remote server.
my $transfer_setting = Infoblox::Grid::DNS::FileTransferSetting->new( type => 'NONE' | 'FTP' | 'SCP', # Required directory => $string, # Optional / default is undefined host => $string, # Optional / default is undefined username => $string, # Optional / default is undefined password => $string, # Optional / default is undefined );
The object does not support any session methods.
The following functions are available to be applied to a DNS traffic capture file transfer setting object.
Use this method to set or retrieve the DNS capture file transfer settings. See Infoblox::Grid::DNS->file_transfer_setting() for parameters and return values.
#Get override_enable_excluded_domain_names value my $override_enable_excluded_domain_names = $object->override_enable_excluded_domain_names();
#Modify override_enable_excluded_domain_names value $object->override_enable_excluded_domain_names("true");
Use this method to set or retrieve the DNS capture file transfer settings. See Infoblox::Grid::Member::DNS->file_transfer_setting() for parameters and return values.
#Get override_enable_excluded_domain_names value my $override_enable_excluded_domain_names = $object->override_enable_excluded_domain_names();
#Modify override_enable_excluded_domain_names value $object->override_enable_excluded_domain_names("true");
This section describes all the methods that can be used to configure and retrieve the attribute values of a DNS traffic capture file transfer setting object.
Use this method to set or retrieve the directory to save the captured DNS queries and responses.
Include the specified parameter to set the attribute value. Omit the parameter to retrieve the attribute value.
The valid value is a desired path in a 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 directory value my $directory = $object->directory();
#Modify directory value $object->directory('/path/to/dir');
Use this method to set or retrieve the hostname for the DNS capture transfer destination server.
Include the specified parameter to set the attribute value. Omit the parameter to retrieve the attribute value.
The valid value is Fully-Qualified Domain Name (FQDN) of the DNS capture transfer destination server.
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 value my $host = $object->host();
#Modify host value $object->host('transfer.com');
Use this method to set the password to access the destination server directory. This is a write-only attribute.
Include the specified parameter to set the attribute value. Omit the parameter to retrieve the attribute value.
The valid value is a desired password in a 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.
#Modify password value $object->password('pass');
Use this method to set or retrieve the transfer protocol used to capture DNS queries and responses.
Include the specified parameter to set the attribute value. Omit the parameter to retrieve the attribute value.
The valid value are 'FTP', 'SCP' and 'NONE'.
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 type value my $type = $object->type();
#Modify type value $object->type('SCP');
Use this method to set or retrieve the username to access the destination server directory.
Include the specified parameter to set the attribute value. Omit the parameter to retrieve the attribute value.
The valid value is a desired username in a 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 username value my $username = $object->username();
#Modify username value $object->username('admin');
Infoblox Inc. http://www.infoblox.com/
Infoblox::Grid::DNS, Infoblox::Grid::DNS->file_transfer_setting(), Infoblox::Grid::Member::DNS, Infoblox::Grid::Member::DNS->file_transfer_setting()
Copyright (c) 2017 Infoblox Inc.