NAME

UltraDNS::Methods - Available UltraDNS Transaction Protocol Methods

SYNOPSIS

  use UltraDNS;

  $udns = UltraDNS->connect(...);

  $udns->...any of these methods...(...);
  $udns->...any of these methods...(...);
  $udns->...any of these methods...(...);

  $udns->commit;

  $udns->...any of these methods...(...);
  $udns->...any of these methods...(...);
  $udns->...any of these methods...(...);

  $udns->commit;

  # etc

DESCRIPTION

This module contains details of the UltraDNS methods defined by the UltraDNS Transaction Protocol documentation.

Refer to UltraDNS for more details.

METHODS

The methods can be called either with our without the UDNS_ prefix that appears in the UltraDNS docs. They're shown here without the prefix because it I prefer it that way.

AddMailForward

  $udns->AddMailForward($string, $string, $zonename);

  $string = emailTo
  $string = forwardTo
  $zonename = domain.

AddRestrictIPForAllZones

  $udns->AddRestrictIPForAllZones($ip_address, $ip_address);

  $ip_address = start_ip
  $ip_address = end_ip

AddRestrictIPForZone

  $udns->AddRestrictIPForZone($zonename, $ip_address, $ip_address);

  $zonename = Zone.
  $ip_address = start_ip
  $ip_address = end_ip

AddUserXInfo

  $udns->AddUserXInfo($string, $string, $string);

  $string = Username
  $string = FieldName
  $string = Value

AddWebForward

  $udns->AddWebForward($string, $string, $unsigned, $zonename);

  $string = requestTo
  $string = redirectTo
  $unsigned = forwardType
  $zonename = domain.

ChangeAliasOfCNAMERecord

  $udns->ChangeAliasOfCNAMERecord($zonename, $hostname, $hostname, $hostname);

  $zonename = Zone.
  $hostname = alias.
  $hostname = host.
  $hostname = NewAlias.

ChangeContentOfTXTRecord

  $udns->ChangeContentOfTXTRecord ($zonename, $hostname, $string, $string);

  $zonename = Zone.
  $hostname = Hostname.
  $string = OldContent
  $string = NewContent

ChangeEmailOfSOARecord

  $udns->ChangeEmailOfSOARecord($zonename, $string);

  $zonename = Zone.
  $string = user@domain.com

ChangeExpireLimitOfSOARecord

  $udns->ChangeExpireLimitOfSOARecord($zonename, $unsigned);

  $zonename = Zone.
  $unsigned = 86400

ChangeHostOfAAAARecord

  $udns->ChangeHostOfAAAARecord($zonename, $hostname, $ipv6_address, $hostname);

  $zonename = Zone.
  $hostname = Hostname.
  $ipv6_address = IPAddress
  $hostname = NewHostname.

ChangeHostOfARecord

  $udns->ChangeHostOfARecord($zonename, $hostname, $ip_address, $hostname);

  $zonename = Zone.
  $hostname = host.
  $ip_address = 1.1.1.1
  $hostname = NewHost.

ChangeHostOfCNAMERecord

  $udns->ChangeHostOfCNAMERecord($zonename, $hostname, $hostname, $hostname);

  $zonename = Zone.
  $hostname = alias.
  $hostname = host.
  $hostname = NewHost.

ChangeHostOfPTRRecord

  $udns->ChangeHostOfPTRRecord($zonename, $hostname, $hostname, $hostname);

  $zonename = Zone.
  $hostname = 1.1.1.1.in-addr.arpa.
  $hostname = host.
  $hostname = NewHost.

ChangeHostOfTXTRecord

  $udns->ChangeHostOfTXTRecord($zonename, $hostname, $string, $hostname);

  $zonename = Zone.
  $hostname = Hostname.
  $string = Content
  $hostname = NewHostname.

ChangeIPOfAAAARecord

  $udns->ChangeIPOfAAAARecord($zonename, $hostname, $ipv6_address, $ipv6_address);

  $zonename = Zone.
  $hostname = Hostname.
  $ipv6_address = IPAddress
  $ipv6_address = New IP

ChangeIPOfARecord

  $udns->ChangeIPOfARecord($zonename, $hostname, $ip_address, $ip_address);

  $zonename = Zone.
  $hostname = host.
  $ip_address = 1.1.1.1
  $ip_address = 1.1.2.2

ChangeIPOfPTRRecord

  $udns->ChangeIPOfPTRRecord($zonename, $hostname, $hostname, $hostname);

  $zonename = Zone.
  $hostname = 1.1.1.1.in-addr.arpa.
  $hostname = host.
  $hostname = 1.1.2.2.in-addr.arpa.

ChangeMailServerOfMXRecord

  $udns->ChangeMailServerOfMXRecord($zonename, $zonename, $hostname, $hostname);

  $zonename = Zone.
  $zonename = ServedZone.
  $hostname = MailServer.
  $hostname = NewServer.

ChangeMinimumCacheOfSOARecord

  $udns->ChangeMinimumCacheOfSOARecord($zonename, $unsigned);

  $zonename = Zone.
  $unsigned = 86400

ChangeNameServerOfNSRecord

  $udns->ChangeNameServerOfNSRecord($zonename, $zonename, $hostname, $hostname);

  $zonename = Zone.
  $zonename = ServedDomain.
  $hostname = NameServer.
  $hostname = NewNameServer.

ChangeNameServerOfSOARecord

  $udns->ChangeNameServerOfSOARecord($zonename, $hostname);

  $zonename = Zone.
  $hostname = NewNameServer.

ChangePriorityOfMXRecord

  $udns->ChangePriorityOfMXRecord($zonename, $zonename, $hostname, $unsigned_short);

  $zonename = Zone.
  $zonename = ServedZone.
  $hostname = MailServer.
  $unsigned_short = 10

ChangeRefreshIntervalOfSOARecord

  $udns->ChangeRefreshIntervalOfSOARecord($zonename, $unsigned);

  $zonename = Zone.
  $unsigned = 86400

ChangeRetryIntervalOfSOARecord

  $udns->ChangeRetryIntervalOfSOARecord($zonename, $unsigned);

  $zonename = Zone.
  $unsigned = 86400

ChangeSerialNumberOfSOARecord

  $udns->ChangeSerialNumberOfSOARecord($zonename, $string);

  $zonename = Zone.
  $string = Serial Number

ChangeServedDomainOfNSRecord

  $udns->ChangeServedDomainOfNSRecord($zonename, $zonename, $hostname, $zonename);

  $zonename = Zone.
  $zonename = ServedDomain.
  $hostname = NameServer.
  $zonename = NewDomain.

ChangeServedZoneOfMXRecord

  $udns->ChangeServedZoneOfMXRecord($zonename, $zonename, $hostname, $zonename);

  $zonename = Zone.
  $zonename = ServedZone.
  $hostname = MailServer.
  $zonename = NewZone.

ChangeTTLOfAAAARecord

  $udns->ChangeTTLOfAAAARecord($zonename, $hostname, $ipv6_address, $unsigned);

  $zonename = Zone.
  $hostname = Hostname.
  $ipv6_address = IPAddress
  $unsigned = NewTTL

ChangeTTLOfARecord

  $udns->ChangeTTLOfARecord($zonename, $hostname, $ip_address, $unsigned);

  $zonename = Zone.
  $hostname = host.
  $ip_address = 1.1.1.1
  $unsigned = NewTTL

ChangeTTLOfCNAMERecord

  $udns->ChangeTTLOfCNAMERecord($zonename, $hostname, $hostname, $unsigned);

  $zonename = Zone.
  $hostname = alias.
  $hostname = host.
  $unsigned = NewTTL

ChangeTTLOfMXRecord

  $udns->ChangeTTLOfMXRecord($zonename, $zonename, $hostname, $unsigned);

  $zonename = Zone.
  $zonename = ServedZone.
  $hostname = MailServer.
  $unsigned = NewTTL

ChangeTTLOfNSRecord

  $udns->ChangeTTLOfNSRecord($zonename, $zonename, $hostname, $unsigned);

  $zonename = Zone.
  $zonename = ServedDomain.
  $hostname = NameServer.
  $unsigned = NewTTL

ChangeTTLOfPTRRecord

  $udns->ChangeTTLOfPTRRecord($zonename, $hostname, $hostname, $unsigned);

  $zonename = Zone.
  $hostname = 1.1.1.1.in-addr.arpa.
  $hostname = host.
  $unsigned = NewTTL

ChangeTTLOfSOARecord

  $udns->ChangeTTLOfSOARecord($zonename, $unsigned);

  $zonename = Zone.
  $unsigned = NewTTL

ChangeTTLOfTXTRecord

  $udns->ChangeTTLOfTXTRecord($zonename, $hostname, $string, $unsigned);

  $zonename = Zone.
  $hostname = Hostname.
  $string = Content
  $unsigned = NewTTL

ChangeUserEmail

  $udns->ChangeUserEmail($string, $string);

  $string = UserName
  $string = NewEmail

ChangeUserPassword

  $udns->ChangeUserPassword($string, $string, $string);

  $string = UserName
  $string = OldPassword
  $string = NewPassword

CloseConnection

  $udns->CloseConnection;

CreateAAAARecord

  $udns->CreateAAAARecord($zonename, $hostname, $ipv6_address);

  $zonename = Zone.
  $hostname = Hostname.
  $ipv6_address = IPAddress

CreateARecord

  $udns->CreateARecord($zonename, $hostname, $ip_address);

  $zonename = ZoneName.
  $hostname = HostName.
  $ip_address = ipAddr

CreateCNAMERecord

  $udns->CreateCNAMERecord($zonename, $hostname, $hostname);

  $zonename = ZoneName.
  $hostname = Alias.
  $hostname = HostName.

CreateMXRecord

  $udns->CreateMXRecord($zonename, $zonename, $hostname, $unsigned_short);

  $zonename = ZoneName.
  $zonename = ServedZone.
  $hostname = MailServer.
  $unsigned_short = priority

CreateNSRecord

  $udns->CreateNSRecord($zonename, $zonename, $hostname);

  $zonename = ZoneName.
  $zonename = SubDomain.
  $hostname = NameServer.

CreatePTRRecord

  $udns->CreatePTRRecord($zonename, $hostname, $hostname);

  $zonename = ZoneName.
  $hostname = 4.3.2.1.in-addr.arpa.
  $hostname = HostName.

CreatePrimaryZone

  $udns->CreatePrimaryZone($zonename);

  $zonename = ZoneName.

CreateRPRecord

  $udns->CreateRPRecord($zonename, $hostname, $string, $string);

  $zonename = Zone.
  $hostname = Host.
  $string = user@domain.com
  $string = data.

CreateResourceRecord

  $udns->CreateResourceRecord($id, $hostname, $unsigned_short, $unsigned_short, $unsigned_short, $hexint);

  $id = 0303372E01CBF764
  $hostname = www.example.biz.
  $unsigned_short = 1
  $unsigned_short = 1025
  $unsigned_short = 300
  $hexint = 982a1479b1273891273c81279831d

CreateSSHFPRecord

  $udns->CreateSSHFPRecord($zonename, $hostname, $unsigned_short, $unsigned_short, $string);

  $zonename = test.zone.
  $hostname = sshfp2.test.zonel.
  $unsigned_short = 0
  $unsigned_short = 1
  $string = 0123456789abcdef

CreateSecondaryZone

  $udns->CreateSecondaryZone($zonename, $ip_address);

  $zonename = ZoneName.
  $ip_address = PrimaryNameServer

CreateTXTRecord

  $udns->CreateTXTRecord($zonename, $hostname, $string);

  $zonename = Zone.
  $hostname = Hostname.
  $string = Content

CreateUser

  $udns->CreateUser($string, $string, $string, $string, $string, $string, $string);

  $string = NewUserName
  $string = Password
  $string = Email
  $string = FirstInitial
  $string = LastInitial
  $string = ServicePkg
  $string = PricingPkg

DeleteAAAARecord

  $udns->DeleteAAAARecord($zonename, $hostname, $ipv6_address);

  $zonename = Zone.
  $hostname = Hostname.
  $ipv6_address = IPAddress

DeleteARecord

  $udns->DeleteARecord($zonename, $hostname, $ip_address);

  $zonename = ZoneName.
  $hostname = HostName.
  $ip_address = ipAddr

DeleteAllRecordsOfUser

  $udns->DeleteAllRecordsOfUser($string);

  $string = UserName

DeleteCNAMERecord

  $udns->DeleteCNAMERecord($zonename, $hostname);

  $zonename = ZoneName.
  $hostname = Alias.

DeleteMXRecord

  $udns->DeleteMXRecord($zonename, $zonename, $hostname);

  $zonename = ZoneName.
  $zonename = ServedZone.
  $hostname = MailServer.

DeleteMailForward

  $udns->DeleteMailForward($string, $zonename);

  $string = guid
  $zonename = domain.

DeleteNSRecord

  $udns->DeleteNSRecord($zonename, $zonename, $hostname);

  $zonename = ZoneName.
  $zonename = SubDomain.
  $hostname = NameServer.

DeletePTRRecord

  $udns->DeletePTRRecord($zonename, $hostname, $hostname);

  $zonename = ZoneName.
  $hostname = 4.3.2.1.in-addr.arpa.
  $hostname = HostName.

DeleteRPRecord

  $udns->DeleteRPRecord($zonename, $hostname, $string);

  $zonename = Zone.
  $hostname = Host.
  $string = email

DeleteResourceRecord

  $udns->DeleteResourceRecord($id, $id);

  $id = 0303372E01CBF764
  $id = 0403372E01CBF99F

DeleteSSHFPRecord

  $udns->DeleteSSHFPRecord($zonename, $hostname);

  $zonename = test.zone.
  $hostname = sshfp.test.zone.

DeleteTXTRecord

  $udns->DeleteTXTRecord($zonename, $hostname);

  $zonename = Zone.
  $hostname = Hostname.

DeleteUser

  $udns->DeleteUser($string);

  $string = UserName

DeleteUserXInfo

  $udns->DeleteUserXInfo($string, $string);

  $string = Username
  $string = FieldName

DeleteWebForward

  $udns->DeleteWebForward($string, $zonename);

  $string = guid
  $zonename = domain.

DeleteZone

  $udns->DeleteZone($zonename);

  $zonename = ZoneName.

DisableAutoSerialUpdate

  $udns->DisableAutoSerialUpdate;

Disconnect

  $udns->Disconnect;

EnableAutoSerialUpdate

  $udns->EnableAutoSerialUpdate;

FindResourceRecords

  $udns->FindResourceRecords($id, $hostname, $unsigned_short);

  $id = 0123456789ABCDEF
  $hostname = hostname.myzone.com.
  $unsigned_short = 1

GetAAAARecordsOfZone

  $udns->GetAAAARecordsOfZone($zonename);

  $zonename = Zone.

GetARecordsOfZone

  $udns->GetARecordsOfZone($zonename);

  $zonename = Zone.

GetASNForRecord

  $udns->GetASNForRecord($id, $id);

  $id = 0123456789ABCDEF
  $id = 123456789ABCDEF0

GetASNList

  $udns->GetASNList;

GetAllRRsOfZone

  $udns->GetAllRRsOfZone($zonename);

  $zonename = Zone.

GetAllZonesOfUser

  $udns->GetAllZonesOfUser($string);

  $string = UserName

GetAutoSerialUpdateState

  $udns->GetAutoSerialUpdateState;

GetCNAMERecordsOfZone

  $udns->GetCNAMERecordsOfZone($zonename);

  $zonename = Zone.

GetDirectionalMaskForRecord

  $udns->GetDirectionalMaskForRecord($id, $id);

  $id = 0123456789ABCDEF
  $id = 123456789ABCDEF0

GetDirectionalServerList

  $udns->GetDirectionalServerList;

GetMXRecordsOfZone

  $udns->GetMXRecordsOfZone($zonename);

  $zonename = Zone.

GetNSRecordsOfZone

  $udns->GetNSRecordsOfZone($zonename);

  $zonename = Zone.

GetPTRRecordsOfZone

  $udns->GetPTRRecordsOfZone($zonename);

  $zonename = Zone.

GetPrimaryZonesOfUser

  $udns->GetPrimaryZonesOfUser($string);

  $string = UserName

GetRPRecordsOfZone

  $udns->GetRPRecordsOfZone($zonename);

  $zonename = Zone.

GetRecordsOfDnameByType

  $udns->GetRecordsOfDnameByType($zonename, $hostname, $int);

  $zonename = Zone.
  $hostname = Hostname.
  $int = Type

GetSOARecordOfZone

  $udns->GetSOARecordOfZone($zonename);

  $zonename = Zone.

GetSSHFPRecordsOfZone

  $udns->GetSSHFPRecordsOfZone($zonename);

  $zonename = test.zone.

GetSecondaryZonesOfUser

  $udns->GetSecondaryZonesOfUser($string);

  $string = UserName

GetServerStatus

  $udns->GetServerStatus;

GetTXTRecordsOfZone

  $udns->GetTXTRecordsOfZone($zonename);

  $zonename = Zone.

GetUserXInfo

  $udns->GetUserXInfo($string, $string);

  $string = Username
  $string = FieldName

GetUsers

  $udns->GetUsers;

GetZoneInfo

  $udns->GetZoneInfo($zonename);

  $zonename = test.zone.

GrantPermissionsToAccountZonesForUser

  $udns->GrantPermissionsToAccountZonesForUser($string, $string, $boolean, $boolean, $boolean, $boolean, $boolean, $boolean, $boolean, $boolean);

  $string = account
  $string = user
  $boolean = allowCreate
  $boolean = allowRead
  $boolean = allowUpdate
  $boolean = allowDelete
  $boolean = denyCreate
  $boolean = denyRead
  $boolean = denyUpdate
  $boolean = denyDelete

GrantPermissionsToMailForwardForUser

  $udns->GrantPermissionsToMailForwardForUser($string, $string, $boolean, $boolean, $boolean, $boolean, $boolean, $boolean, $boolean, $boolean);

  $string = user
  $string = mailforward
  $boolean = allowCreate
  $boolean = allowRead
  $boolean = allowUpdate
  $boolean = allowDelete
  $boolean = denyCreate
  $boolean = denyRead
  $boolean = denyUpdate
  $boolean = denyDelete

GrantPermissionsToWebForwardForUser

  $udns->GrantPermissionsToWebForwardForUser($string, $string, $boolean, $boolean, $boolean, $boolean, $boolean, $boolean, $boolean, $boolean);

  $string = user
  $string = webforward
  $boolean = allowCreate
  $boolean = allowRead
  $boolean = allowUpdate
  $boolean = allowDelete
  $boolean = denyCreate
  $boolean = denyRead
  $boolean = denyUpdate
  $boolean = denyDelete

GrantPermissionsToZoneForUser

  $udns->GrantPermissionsToZoneForUser($string, $zonename, $boolean, $boolean, $boolean, $boolean, $boolean, $boolean, $boolean, $boolean);

  $string = user
  $zonename = Zone.
  $boolean = allowCreate
  $boolean = allowRead
  $boolean = allowUpdate
  $boolean = allowDelete
  $boolean = denyCreate
  $boolean = denyRead
  $boolean = denyUpdate
  $boolean = denyDelete

GrantPermissionsToZoneMailForwardsForUser

  $udns->GrantPermissionsToZoneMailForwardsForUser($string, $zonename, $boolean, $boolean, $boolean, $boolean, $boolean, $boolean, $boolean, $boolean);

  $string = user
  $zonename = Zone.
  $boolean = allowCreate
  $boolean = allowRead
  $boolean = allowUpdate
  $boolean = allowDelete
  $boolean = denyCreate
  $boolean = denyRead
  $boolean = denyUpdate
  $boolean = denyDelete

GrantPermissionsToZoneWebForwardsForUser

  $udns->GrantPermissionsToZoneWebForwardsForUser($string, $zonename, $boolean, $boolean, $boolean, $boolean, $boolean, $boolean, $boolean, $boolean);

  $string = user
  $zonename = Zone.
  $boolean = allowCreate
  $boolean = allowRead
  $boolean = allowUpdate
  $boolean = allowDelete
  $boolean = denyCreate
  $boolean = denyRead
  $boolean = denyUpdate
  $boolean = denyDelete

QueryMailForwards

  $udns->QueryMailForwards($zonename);

  $zonename = domain.

QueryWebForwards

  $udns->QueryWebForwards($zonename);

  $zonename = domain.

RemoveRestrictIPForAllZones

  $udns->RemoveRestrictIPForAllZones;

RemoveRestrictIPForZone

  $udns->RemoveRestrictIPForZone($zonename, $ip_address, $ip_address);

  $zonename = Zone.
  $ip_address = start_ip
  $ip_address = end_ip

RequestZoneTransfer

  $udns->RequestZoneTransfer($zonename);

  $zonename = Zone.

SetASNForRecord

  $udns->SetASNForRecord($id, $id, $integer);

  $id = 0123456789ABCDEF
  $id = 123456789ABCDEF0
  $integer = 1

SetDirectionalMaskForRecord

  $udns->SetDirectionalMaskForRecord($id, $id, \@array);

  $id = 0123456789ABCDEF
  $id = 123456789ABCDEF0
  \@array = [ $unsigned_int, ... ]

UpdateAAAARecords

  $udns->UpdateAAAARecords($zonename, $hostname, @ipv6_address);

  $zonename = Zone.
  $hostname = Hostname.
  @ipv6_address = (IPAddress, ...)

UpdateARecords

  $udns->UpdateARecords($zonename, $hostname, @ip_address);

  $zonename = Zone.
  $hostname = Hostname.
  @ip_address = (IP address, ...)

UpdateCNAMERecords

  $udns->UpdateCNAMERecords($zonename, $hostname, @hostname);

  $zonename = Zone.
  $hostname = CNAME.
  @hostname = (Hostname., ...)

UpdateMailForward

  $udns->UpdateMailForward($string, $string, $zonename);

  $string = guid
  $string = forwardTo
  $zonename = domain.

UpdateNSRecords

  $udns->UpdateNSRecords($zonename, $zonename, @hostname);

  $zonename = Zone.
  $zonename = Zone for NS.
  @hostname = (NS hostname., ...)

UpdateWebForward

  $udns->UpdateWebForward($string, $string, $string, $unsigned, $zonename);

  $string = guid
  $string = requestTo
  $string = redirectTo
  $unsigned = forwardType
  $zonename = domain.