en-US/PoShDynDnsApi-help.xml
|
<?xml version="1.0" encoding="utf-8"?>
<helpItems schema="maml" xmlns="http://msh"> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Add-DynDnsHttpRedirect</command:name> <command:verb>Add</command:verb> <command:noun>DynDnsHttpRedirect</command:noun> <maml:description> <maml:para>The command Add-DynDnsHttpRedirect creates a new HTTP Redirect service on the zone/node indicated.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The command Add-DynDnsHttpRedirect creates a new HTTP Redirect service on the zone/node indicated. Note: Creating a new HTTP redirect will automatically publish the change to the zone.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-DynDnsHttpRedirect</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Zone</maml:name> <maml:Description> <maml:para>The zone in which to create the HTTP Redirect service.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Node</maml:name> <maml:Description> <maml:para>A node in the specified zone. If the node does not end with the domain of the zone, it will be appended.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>Url</maml:name> <maml:Description> <maml:para>The target URL where the client is sent. Must begin with either http:// or https://.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>ResponseCode</maml:name> <maml:Description> <maml:para>The HTTP response code to return for redirection.</maml:para> <maml:para>301 - Permanent redirect\ 302 - Temporary redirect</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">301</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">302</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>Prompts you for confirmation before running the command.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IncludeUri</maml:name> <maml:Description> <maml:para>Sets the flag indicating whether the redirection should include the originally requested URI.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Shows what would happen if the command runs. The command is not run.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>Prompts you for confirmation before running the command.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IncludeUri</maml:name> <maml:Description> <maml:para>Sets the flag indicating whether the redirection should include the originally requested URI.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Node</maml:name> <maml:Description> <maml:para>A node in the specified zone. If the node does not end with the domain of the zone, it will be appended.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>ResponseCode</maml:name> <maml:Description> <maml:para>The HTTP response code to return for redirection.</maml:para> <maml:para>301 - Permanent redirect\ 302 - Temporary redirect</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>Url</maml:name> <maml:Description> <maml:para>The target URL where the client is sent. Must begin with either http:// or https://.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Shows what would happen if the command runs. The command is not run.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Zone</maml:name> <maml:Description> <maml:para>The zone in which to create the HTTP Redirect service.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>DynDnsHttpRedirect</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------------------------- Example ---------------------------</maml:title> <dev:code>PS C:\> Add-DynDnsHttpRedirect -Zone anovelidea.org -Node newtest -Url https://www.anovelidea.org -ResponseCode 301 -IncludeUri WARNING: This will autopublish the HTTP redirect to the zone. Confirm Are you sure you want to perform this action? Performing the operation "Create HTTP redirect to https://www.anovelidea.org" on target "newtest.anovelidea.org". [Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"): y Zone : anovelidea.org Name : newtest.anovelidea.org Url : https://www.anovelidea.org ResponseCode : 301 IncludeUri : True</dev:code> <dev:remarks> <maml:para>Create a new HTTP redirect service to permanently redirect newtest.anovelidea.org to https://www.anovelidea.org.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://powershell.anovelidea.org/modulehelp/PoShDynDnsApi/Add-DynDnsHttpRedirect.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-DynDnsHttpRedirect</maml:linkText> <maml:uri>https://powershell.anovelidea.org/modulehelp/PoShDynDnsApi/Get-DynDnsHttpRedirect.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-DynDnsHttpRedirect</maml:linkText> <maml:uri>https://powershell.anovelidea.org/modulehelp/PoShDynDnsApi/Remove-DynDnsHttpRedirect.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Create HTTP Redirect (API)</maml:linkText> <maml:uri>https://help.dyn.com/create-http-redirect-api/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Add-DynDnsRecord</command:name> <command:verb>Add</command:verb> <command:noun>DynDnsRecord</command:noun> <maml:description> <maml:para>Creates a new DNS record of the specified type at the indicated zone/node level.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Creates a new DNS record of the specified type at the indicated zone/node level.</maml:para> <maml:para>Currently, adding the following DNS record types are supported:</maml:para> <maml:para>* A</maml:para> <maml:para>* TXT</maml:para> <maml:para>* CNAME</maml:para> <maml:para>* MX</maml:para> <maml:para>* SRV</maml:para> <maml:para>* PTR</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-DynDnsRecord</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Zone</maml:name> <maml:Description> <maml:para>The zone in which to create the DNS record.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Node</maml:name> <maml:Description> <maml:para>A node in the specified zone. If the node does not end with the domain of the zone, it will be appended.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>DynDnsRecord</maml:name> <maml:Description> <maml:para>A DynDnsRecord object.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DynDnsRecord</command:parameterValue> <dev:type> <maml:name>DynDnsRecord</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>Prompts you for confirmation before running the command.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Shows what would happen if the command runs. The command is not run.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>Prompts you for confirmation before running the command.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>DynDnsRecord</maml:name> <maml:Description> <maml:para>A DynDnsRecord object.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DynDnsRecord</command:parameterValue> <dev:type> <maml:name>DynDnsRecord</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Node</maml:name> <maml:Description> <maml:para>A node in the specified zone. If the node does not end with the domain of the zone, it will be appended.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Shows what would happen if the command runs. The command is not run.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Zone</maml:name> <maml:Description> <maml:para>The zone in which to create the DNS record.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>DynDnsRecord</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Add-DynDnsRecord -Zone anovelidea.org -Node www -DynDnsRecord (New-DynDnsRecord -IPv4Address 74.125..21.121) Confirm Are you sure you want to perform this action? Performing the operation "Adding DNS record" on target "A - www.anovelidea.org". [Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"): y Address : 74.125.21.121 Zone : anovelidea.org Name : www.anovelidea.org Type : A TTL : 3600</dev:code> <dev:remarks> <maml:para>Add an A record for the hostname www.anovelidea.org.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> Add-DynDnsRecord -Zone anovelidea.org -DynDnsRecord (New-DynDnsRecord -Text "testing" ) Confirm Are you sure you want to perform this action? Performing the operation "Adding DNS record" on target "TXT - anovelidea.org". [Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"): y Strings : {testing} Zone : anovelidea.org Name : anovelidea.org Type : TXT TTL : 3600</dev:code> <dev:remarks> <maml:para>Add a TXT record to the root of the zone anovelidea.org.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>PS C:\> Add-DynDnsRecord -Zone anovelidea.org -Node www3 -DynDnsRecord (New-DynDnsRecord -IPv4Address 74.125.21.121) Confirm Are you sure you want to perform this action? Performing the operation "Adding DNS record" on target "A - www3.anovelidea.org". [Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"): y WARNING: API-3.7.11 : ERROR : DYN : TARGET_EXISTS : make: Cannot duplicate existing record data</dev:code> <dev:remarks> <maml:para>Demonstrates an attempt to add an a record that currently exists.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://powershell.anovelidea.org/modulehelp/PoShDynDnsApi/Add-DynDnsRecord.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-DynDnsRecord</maml:linkText> <maml:uri>https://powershell.anovelidea.org/modulehelp/PoShDynDnsApi/Get-DynDnsRecord.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-DynDnsRecord</maml:linkText> <maml:uri>https://powershell.anovelidea.org/modulehelp/PoShDynDnsApi/Update-DynDnsRecord.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-DynDnsRecord</maml:linkText> <maml:uri>https://powershell.anovelidea.org/modulehelp/PoShDynDnsApi/Remove-DynDnsRecord.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Create an A Record (API)</maml:linkText> <maml:uri>https://help.dyn.com/create-a-record-api/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Create CNAME Records (API)</maml:linkText> <maml:uri>https://help.dyn.com/create-cname-records-api/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Create MX Record (API)</maml:linkText> <maml:uri>https://help.dyn.com/create-mx-record-api/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Create PTR Record (API)</maml:linkText> <maml:uri>https://help.dyn.com/create-ptr-record-api/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Create SRV Record (API)</maml:linkText> <maml:uri>https://help.dyn.com/create-srv-record-api/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Create TXT Record (API)</maml:linkText> <maml:uri>https://help.dyn.com/create-txt-record-api/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Add-DynDnsZone</command:name> <command:verb>Add</command:verb> <command:noun>DynDnsZone</command:noun> <maml:description> <maml:para>The Add-DynDnsZone command creates a primary DNS zone in the customer's Dyn DNS Managed account.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The command Add-DynDnsZone creates a primary DNS zone in the customer's Dyn DNS Managed account. Note: After creating the new zone, you must use Publish-DynDnsZoneChanges -Zone <zone_name> -Force to publish the zone before adding additional records.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-DynDnsZone</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>Prompts you for confirmation before running the command.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ResponsiblePerson</maml:name> <maml:Description> <maml:para>The email address of the person responsible for the domain.</maml:para> <maml:para>The value provided must match the syntax for an email address.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SerialStyle</maml:name> <maml:Description> <maml:para>Provide the style for the zone's serial.</maml:para> <maml:para>|Style|Description| |-|-| |increment|Serials are incremented by 1 on every change.| |epoch|Serials will be the UNIX timestamp at the time of the publish.| |day|Serials will be in the form of YYYYMMDDxx where xx is incremented by one for each change during that particular day.| |minute|Serials will be in the form of YYMMDDHHMM.|</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">increment</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">epoch</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">day</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">minute</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>day</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>TTL</maml:name> <maml:Description> <maml:para>The default TTL (Time-To-Live) for records in the zone.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Shows what would happen if the command runs. The command is not run.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Zone</maml:name> <maml:Description> <maml:para>The fully qualified name of the DNS domain for which to create the a primary zone.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Add-DynDnsZone</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>Prompts you for confirmation before running the command.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Shows what would happen if the command runs. The command is not run.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Zone</maml:name> <maml:Description> <maml:para>The fully qualified name of the DNS domain for which to create the a primary zone.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ZoneFile</maml:name> <maml:Description> <maml:para>The contents of a RFC1035 style Master file. A zone file for BIND or tinydns will also be accepted.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>Prompts you for confirmation before running the command.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ResponsiblePerson</maml:name> <maml:Description> <maml:para>The email address of the person responsible for the domain.</maml:para> <maml:para>The value provided must match the syntax for an email address.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SerialStyle</maml:name> <maml:Description> <maml:para>Provide the style for the zone's serial.</maml:para> <maml:para>|Style|Description| |-|-| |increment|Serials are incremented by 1 on every change.| |epoch|Serials will be the UNIX timestamp at the time of the publish.| |day|Serials will be in the form of YYYYMMDDxx where xx is incremented by one for each change during that particular day.| |minute|Serials will be in the form of YYMMDDHHMM.|</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>day</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>TTL</maml:name> <maml:Description> <maml:para>The default TTL (Time-To-Live) for records in the zone.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Shows what would happen if the command runs. The command is not run.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Zone</maml:name> <maml:Description> <maml:para>The fully qualified name of the DNS domain for which to create the a primary zone.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ZoneFile</maml:name> <maml:Description> <maml:para>The contents of a RFC1035 style Master file. A zone file for BIND or tinydns will also be accepted.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Add-DynDnsZone -Zone 'anovelidea.org' -ResponsiblePerson 'powershell@anovelidea.org' -SerialStyle day -TTL 300 Confirm Are you sure you want to perform this action? Performing the operation "Create DNS zone" on target "anovelidea.org". [Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"): y Zone SerialNumber SerialStyle Type ---- ------------ ----------- ---- anovelidea.org 0 day Primary PS C:\> Publish-DynDnsZoneChanges -Zone anovelidea.org -Notes 'Creating zone for module help.' -Force WARNING: There are no pending zone changes. Confirm Are you sure you want to perform this action? Performing the operation "publish zone changes" on target "anovelidea.org". [Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"): y Zone SerialNumber SerialStyle Type ---- ------------ ----------- ---- anovelidea.org 2018091600 day Primary</dev:code> <dev:remarks> <maml:para>Creates a new primary DNS zone by providing the zone name, responsible person, serial style, and default TTL.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> Add-DynDnsZone -Zone anovelidea.org -ResponsiblePerson BadEmailAddress WARNING: The value provided for ResponsiblePerson does not appear to be a valid email. Please try again.</dev:code> <dev:remarks> <maml:para>Demonstrates the use of an invalid email address for ResponsiblePerson.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>PS C:\> Add-DynDnsZone -Zone anovelidea.org -ZoneFile C:\Downloads\anovelidea.org.zonefile.txt Confirm Are you sure you want to perform this action? Performing the operation "Create DNS zone by ZoneFile method" on target "anovelidea.org". [Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"): y If you plan to provide your own secondary DNS for the zone, allow notify requests from these IP addresses on your nameserver: 208.78.68.66, 2600:2003:0:1::66 Zone anovelidea.org import initiated. This task may take a several minutes to complete. Please be sure to reassign the zone delegation to us. Zone is not yet delegated to us Note: Be sure to use the function Publish-DynDnsZoneChanges in order publish the domain.</dev:code> <dev:remarks> <maml:para>Create a primary DNS zone by importing a file.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://powershell.anovelidea.org/modulehelp/PoShDynDnsApi/Add-DynDnsZone.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-DynDnsZone</maml:linkText> <maml:uri>https://powershell.anovelidea.org/modulehelp/PoShDynDnsApi/Get-DynDnsZone.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-DynDnsZone</maml:linkText> <maml:uri>https://powershell.anovelidea.org/modulehelp/PoShDynDnsApi/Remove-DynDnsZone.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Publish-DynDnsZoneChanges</maml:linkText> <maml:uri>https://powershell.anovelidea.org/modulehelp/PoShDynDnsApi/Publish-DynDnsZoneChanges.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Create Primary Zone (API)</maml:linkText> <maml:uri>https://help.dyn.com/create-primary-zone-api/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Upload Zone File (API)</maml:linkText> <maml:uri>https://help.dyn.com/upload-zone-file-api/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Connect-DynDnsSession</command:name> <command:verb>Connect</command:verb> <command:noun>DynDnsSession</command:noun> <maml:description> <maml:para>The Connect-DynDnsSession command creates a new session to the Dyn Managed DNS REST API.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Connect-DynDnsSession command creates a new session to the Dyn Managed DNS REST API.</maml:para> <maml:para>An authenticated and active Dyn Managed DNS session is required for all interactions with the service. From the Dyn page on Session Log-in > WARNING: Operating on the same resource (e.g. the same hostname or instance of a service) from more than one session at the same time may cause unexpected behavior, such as unintentional service changes or the inability to propagate new zone changes.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Connect-DynDnsSession</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="ApiUserName, UserName"> <maml:name>User</maml:name> <maml:Description> <maml:para>The Dyn API user (not DynID).</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="CustomerName"> <maml:name>Customer</maml:name> <maml:Description> <maml:para>The customer name for the Dyn API user.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="pwd, pass"> <maml:name>Password</maml:name> <maml:Description> <maml:para>The Dyn API user password.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">SecureString</command:parameterValue> <dev:type> <maml:name>SecureString</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:Description> <maml:para>Discards an existing, valid session before creating a new session.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="CustomerName"> <maml:name>Customer</maml:name> <maml:Description> <maml:para>The customer name for the Dyn API user.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:Description> <maml:para>Discards an existing, valid session before creating a new session.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="pwd, pass"> <maml:name>Password</maml:name> <maml:Description> <maml:para>The Dyn API user password.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">SecureString</command:parameterValue> <dev:type> <maml:name>SecureString</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="ApiUserName, UserName"> <maml:name>User</maml:name> <maml:Description> <maml:para>The Dyn API user (not DynID).</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> $User = Read-Host -Prompt 'Enter Dyn Managed DNS User Name' PS C:\> $Customer = Read-Host -Prompt 'Enter Dyn Managed DNS Customer Name' PS C:\> $Password = Read-Host -Prompt 'Enter Dyn Managed DNS Password' -AsSecureString PS C:\> Connect-DynDnsSession -User $User -Customer $Customer -Password $Password</dev:code> <dev:remarks> <maml:para>Connects to the Dyn Managed DNS API using the provided credentials.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> Connect-DynDnsSession -User $User -Customer $Customer -Password $Password WARNING: There is a valid active session. Use the -Force parameter to logoff and create a new session. WARNING: All unpublished changes will be discarded should you proceed with creating a new session. PS C:\> Connect-DynDnsSession -User $User -Customer $Customer -Password $Password -Force -Verbose VERBOSE: Existing authentication token found. VERBOSE: API-3.7.11 : INFO : BLL : isalive: User session is still active VERBOSE: API-3.7.11 : INFO : BLL : logout: Logout successful VERBOSE: API-3.7.11 : INFO : BLL : login: Login successful</dev:code> <dev:remarks> <maml:para>Terminates a current session and creates a new session to the Dyn Managed DNS API using the provided credentials.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://powershell.anovelidea.org/modulehelp/PoShDynDnsApi/Connect-DynDnsSession.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Disconnect-DynDnsSession</maml:linkText> <maml:uri>https://powershell.anovelidea.org/modulehelp/PoShDynDnsApi/Disconnect-DynDnsSession.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Send-DynDnsSession</maml:linkText> <maml:uri>https://powershell.anovelidea.org/modulehelp/PoShDynDnsApi/Send-DynDnsSession.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Test-DynDnsSession</maml:linkText> <maml:uri>https://powershell.anovelidea.org/modulehelp/PoShDynDnsApi/Test-DynDnsSession.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-DynDnsSession</maml:linkText> <maml:uri>https://powershell.anovelidea.org/modulehelp/PoShDynDnsApi/Get-DynDnsSession.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Session Log-in (API)</maml:linkText> <maml:uri>https://help.dyn.com/session-log-in/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Disconnect-DynDnsSession</command:name> <command:verb>Disconnect</command:verb> <command:noun>DynDnsSession</command:noun> <maml:description> <maml:para>The Disconnect-DynDnsSession command terminates an existing, valid session with the Dyn Managed DNS REST API.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Disconnect-DynDnsSession command terminates an existing, valid session with the Dyn Managed DNS REST API.</maml:para> <maml:para>The command issues a session logout and removes the authentication token, user, and customer module variables.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Disconnect-DynDnsSession</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------------------------- Example ---------------------------</maml:title> <dev:code>PS C:\> Disconnect-DynDnsSession</dev:code> <dev:remarks> <maml:para>Terminates an existing session.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://powershell.anovelidea.org/modulehelp/PoShDynDnsApi/Disconnect-DynDnsSession.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-DynDnsSession.</maml:linkText> <maml:uri>https://powershell.anovelidea.org/modulehelp/PoShDynDnsApi/Connect-DynDnsSession.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Send-DynDnsSession</maml:linkText> <maml:uri>https://powershell.anovelidea.org/modulehelp/PoShDynDnsApi/Send-DynDnsSession.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Test-DynDnsSession</maml:linkText> <maml:uri>https://powershell.anovelidea.org/modulehelp/PoShDynDnsApi/Test-DynDnsSession.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Session Log-out (API)</maml:linkText> <maml:uri>https://help.dyn.com/session-log-out/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-DynDnsHistory</command:name> <command:verb>Get</command:verb> <command:noun>DynDnsHistory</command:noun> <maml:description> <maml:para>The command Get-DynDnsHistory shows the history of commands that are send to the Dyn Managed DNS REST API.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The command Get-DynDnsHistory shows the history of commands that are send to the Dyn Managed DNS REST API.</maml:para> <maml:para>The following properties are included:</maml:para> <maml:para>|Property|Description| |-|-| |Timestamp|When the command was executed |Command|The name of the command |Status|The result from the Dyn API |JobId|The job id for this particular call to the Dyn API |Method|The REST method for this call |Uri|The full URL used in the call |StatusCode|The HTTP status code |StatusDescription|A description of the status code |ElapsedTime|The elapsed time for the command to return results from the Dyn API, in seconds. |Arguments|The arguments used by the command. Note, the common parameters are omitted, as well as a few others.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-DynDnsHistory</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>First</maml:name> <maml:Description> <maml:para>Gets only the first 'n' command results.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Last</maml:name> <maml:Description> <maml:para>Gets only the last 'n' command results.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Skip</maml:name> <maml:Description> <maml:para>Ignores the first 'n' command results and then gets the remaining results.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-DynDnsHistory</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>First</maml:name> <maml:Description> <maml:para>Gets only the first 'n' command results.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Last</maml:name> <maml:Description> <maml:para>Gets only the last 'n' command results.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SkipLast</maml:name> <maml:Description> <maml:para>Ignores the last 'n' command results.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>First</maml:name> <maml:Description> <maml:para>Gets only the first 'n' command results.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Last</maml:name> <maml:Description> <maml:para>Gets only the last 'n' command results.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Skip</maml:name> <maml:Description> <maml:para>Ignores the first 'n' command results and then gets the remaining results.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SkipLast</maml:name> <maml:Description> <maml:para>Ignores the last 'n' command results.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>DynDnsHistory</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-DynDnsHistory Timestamp : 11/10/2018 4:33:50 PM Command : Test-DynDnsSession Status : JobId : Method : Uri : StatusCode : StatusDescription : ElapsedTime : Arguments : {} Timestamp : 11/10/2018 4:33:51 PM Command : Connect-DynDnsSession Status : success JobId : 860420327 Method : POST Uri : https://api.dynect.net/REST/Session/ StatusCode : 200 StatusDescription : OK ElapsedTime : 0.798 Arguments : {} Timestamp : 11/10/2018 4:33:55 PM Command : Test-DynDnsSession Status : success JobId : 860420509 Method : GET Uri : https://api.dynect.net/REST/Session/ StatusCode : 200 StatusDescription : OK ElapsedTime : 0.150 Arguments : {} Timestamp : 11/10/2018 4:33:55 PM Command : Add-DynDnsHttpRedirect Status : success JobId : 860420521 Method : POST Uri : https://api.dynect.net/REST/HTTPRedirect/anovelidea.org/myredirect.anovelidea.org StatusCode : 200 StatusDescription : OK ElapsedTime : 0.358 Arguments : {IncludeUri, Url, Node, Zone...}</dev:code> <dev:remarks> <maml:para>List all the commands sent to the Dyn Managed DNS REST API.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://powershell.anovelidea.org/modulehelp/PoShDynDnsApi/Get-DynDnsHistory.html</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-DynDnsHttpRedirect</command:name> <command:verb>Get</command:verb> <command:noun>DynDnsHttpRedirect</command:noun> <maml:description> <maml:para>Retrieves one or all HTTP Redirect services on the zone/node indicated.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Retrieves one or all HTTP Redirect services on the zone/node indicated.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-DynDnsHttpRedirect</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Zone</maml:name> <maml:Description> <maml:para>The zone in which to create the HTTP redirect service.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Node</maml:name> <maml:Description> <maml:para>A node in the specified zone. If the node does not end with the domain of the zone, it will be appended.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Node</maml:name> <maml:Description> <maml:para>A node in the specified zone. If the node does not end with the domain of the zone, it will be appended.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Zone</maml:name> <maml:Description> <maml:para>The zone in which to create the HTTP redirect service.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>DynDnsHttpRedirect</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------------------------- Example ---------------------------</maml:title> <dev:code>PS C:\> Get-DynDnsHttpRedirect -Zone anovelidea.org -Node redirect Zone : anovelidea.org Name : redirect.anovelidea.org Url : https://www.anovelidea.org ResponseCode : 301 IncludeUri : True</dev:code> <dev:remarks> <maml:para>Retrieve HTTP redirect service for node redirect.anovelidea.org.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Get-DynDnsHttpRedirect</maml:linkText> <maml:uri>https://powershell.anovelidea.org/modulehelp/PoShDynDnsApi/Get-DynDnsHttpRedirect.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-DynDnsHttpRedirect</maml:linkText> <maml:uri>https://powershell.anovelidea.org/modulehelp/PoShDynDnsApi/Add-DynDnsHttpRedirect.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Create HTTP Redirect (API)</maml:linkText> <maml:uri>https://help.dyn.com/create-http-redirect-api/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-DynDnsJob</command:name> <command:verb>Get</command:verb> <command:noun>DynDnsJob</command:noun> <maml:description> <maml:para>The command Get-DynDnsJob retrieves the result from a previous job.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The command Get-DynDnsJob retrieves the result from a previous job.</maml:para> <maml:para>The JobId is in the command history which can be retrieved with the command Get-DynDnsHistory. It is also included in the Information stream which can be accessed, at time of command execution, via -InformationAction Continue and -InformationVariable CommandInfo.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-DynDnsJob</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>JobId</maml:name> <maml:Description> <maml:para>The JobId which corresponds to a previous API call.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>JobId</maml:name> <maml:Description> <maml:para>The JobId which corresponds to a previous API call.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>DynDnsRawData</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-DynDnsJob -JobId 836040075 User : dcarroll Status : active CustomerName : Dave Carroll Nickname : owner FirstName : Dave LastName : Carroll Email : powershell@anovelidea.org Phone : 8053642175 Groups : {Default}</dev:code> <dev:remarks> <maml:para>The job with id 836040075 contained the results for a Get-DynDnsUser command.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://powershell.anovelidea.org/modulehelp/PoShDynDnsApi/Get-DynDnsJob.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-DynDnsHistory</maml:linkText> <maml:uri>https://powershell.anovelidea.org/modulehelp/PoShDynDnsApi/Get-DynDnsHistory.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get Job (API)</maml:linkText> <maml:uri>https://help.dyn.com/get-job/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-DynDnsNodeList</command:name> <command:verb>Get</command:verb> <command:noun>DynDnsNodeList</command:noun> <maml:description> <maml:para>The Get-DynDnsNodeList command retrieves a list of all node names at or below the given zone node.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-DynDnsNodeList command retrieves a list of all node names at or below the given zone node.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-DynDnsNodeList</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Zone</maml:name> <maml:Description> <maml:para>The zone in which to query for nodes.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Node</maml:name> <maml:Description> <maml:para>A node in the specified zone. If the node does not end with the domain of the zone, it will be appended.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Node</maml:name> <maml:Description> <maml:para>A node in the specified zone. If the node does not end with the domain of the zone, it will be appended.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Zone</maml:name> <maml:Description> <maml:para>The zone in which to query for nodes.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object[]</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------------------------- Example ---------------------------</maml:title> <dev:code>PS C:\> Get-DynDnsNodeList -Zone anovelidea.org anovelidea.org newtest.anovelidea.org redirect.anovelidea.org www3.anovelidea.org</dev:code> <dev:remarks> <maml:para>List all of the nodes for the zone anovelidea.org.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://powershell.anovelidea.org/modulehelp/PoShDynDnsApi/Get-DynDnsNodeList.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-DynDnsNode</maml:linkText> <maml:uri>https://powershell.anovelidea.org/modulehelp/PoShDynDnsApi/Remove-DynDnsNode.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get Node List (API)</maml:linkText> <maml:uri>https://help.dyn.com/get-node-list-api/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-DynDnsRecord</command:name> <command:verb>Get</command:verb> <command:noun>DynDnsRecord</command:noun> <maml:description> <maml:para>The command Get-DynDnsRecord retrieves one or all records of the specified type from a specified zone/node.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The command Get-DynDnsRecord retrieves one or all records of the specified type from a specified zone/node.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-DynDnsRecord</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Zone</maml:name> <maml:Description> <maml:para>The zone in which to query for the specific record type.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>RecordType</maml:name> <maml:Description> <maml:para>Specifies the record type for which to query.</maml:para> <maml:para>The following record types are currently supported.</maml:para> <maml:para>* A</maml:para> <maml:para>* TXT</maml:para> <maml:para>* CNAME</maml:para> <maml:para>* MX</maml:para> <maml:para>* SRV</maml:para> <maml:para>* PTR</maml:para> <maml:para>* SOA</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">SOA</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">NS</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">MX</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">TXT</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">SRV</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">CNAME</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">PTR</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">A</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">All</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>Node</maml:name> <maml:Description> <maml:para>A node in the specified zone. If the node does not end with the domain of the zone, it will be appended.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>Node</maml:name> <maml:Description> <maml:para>A node in the specified zone. If the node does not end with the domain of the zone, it will be appended.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>RecordType</maml:name> <maml:Description> <maml:para>Specifies the record type for which to query.</maml:para> <maml:para>The following record types are currently supported.</maml:para> <maml:para>* A</maml:para> <maml:para>* TXT</maml:para> <maml:para>* CNAME</maml:para> <maml:para>* MX</maml:para> <maml:para>* SRV</maml:para> <maml:para>* PTR</maml:para> <maml:para>* SOA</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Zone</maml:name> <maml:Description> <maml:para>The zone in which to query for the specific record type.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>DynDnsRecord</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-DynDnsRecord -Zone anovelidea.org -RecordType A Address : 74.125.21.121 Zone : anovelidea.org Name : anovelidea.org Type : A TTL : 3600</dev:code> <dev:remarks> <maml:para>List all A records for the node anovelidea.org.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> Get-DynDnsRecord -Zone anovelidea.org -RecordType SOA Administrator : powershell.anovelidea.org. SerialNumber : 2018110400 PrimaryServer : ns1.p01.dynect.net. TimeToExpiration : 604800 TimeToZoneFailureRetry : 600 TimeToZoneRefresh : 3600 DefaultTTL : 1800 Zone : anovelidea.org Name : anovelidea.org Type : SOA TTL : 3600</dev:code> <dev:remarks> <maml:para>List all NameServer (NS) records in the zone anovelidea.org.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://powershell.anovelidea.org/modulehelp/PoShDynDnsApi/Get-DynDnsRecord.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-DynDnsRecord</maml:linkText> <maml:uri>https://powershell.anovelidea.org/modulehelp/PoShDynDnsApi/Add-DynDnsRecord.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-DynDnsRecord</maml:linkText> <maml:uri>https://powershell.anovelidea.org/modulehelp/PoShDynDnsApi/Remove-DynDnsRecord.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get A Records (API)</maml:linkText> <maml:uri>https://help.dyn.com/get-a-records-api/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get PTR Records (API)</maml:linkText> <maml:uri>https://help.dyn.com/get-ptr-records-api/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get CNAME Records (API)</maml:linkText> <maml:uri>https://help.dyn.com/get-cname-records-api/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get SRV Records (API)</maml:linkText> <maml:uri>https://help.dyn.com/get-srv-records-api/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get TXT Records (API)</maml:linkText> <maml:uri>https://help.dyn.com/get-txt-records-api/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get MX Records (API)</maml:linkText> <maml:uri>https://help.dyn.com/get-mx-records-api/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get NS Records (API)</maml:linkText> <maml:uri>https://help.dyn.com/get-ns-records-api/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get SOA Records (API)</maml:linkText> <maml:uri>https://help.dyn.com/get-soa-records-api/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get All Records (API)</maml:linkText> <maml:uri>https://help.dyn.com/get-all-records-api/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-DynDnsSession</command:name> <command:verb>Get</command:verb> <command:noun>DynDnsSession</command:noun> <maml:description> <maml:para>The command Get-DynDnsSession retrieves information about the current session.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The command Get-DynDnsSession retrieves information about the current session.</maml:para> <maml:para>The output includes the start time (set when connected using Connect-DynDnsSession) and refresh time (set when refreshed when using Send-DynDnsSession). The ElapsedTime property has a running [System.Diagnostics.Stopwatch] instance.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-DynDnsSession</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-DynDnsSession ClientUrl : https://api.dynect.net User : dcarroll Customer : thedavecarroll ApiVersion : 3.7.11 AuthToken : ******************************************************************= StartTime : 11/10/2018 10:33:51 PM ElapsedTime : @{IsRunning=True; Elapsed=; ElapsedMilliseconds=3278473; ElapsedTicks=6377654595} RefreshTime : 11/10/2018 11:28:29 PM</dev:code> <dev:remarks> <maml:para>Retrieve information regarding the current session with the Dyn Managed DNS API.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://powershell.anovelidea.org/modulehelp/PoShDynDnsApi/Get-DynDnsSession.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-DynDnsSession</maml:linkText> <maml:uri>https://powershell.anovelidea.org/modulehelp/PoShDynDnsApi/Disconnect-DynDnsSession.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Disconnect-DynDnsSession</maml:linkText> <maml:uri>https://powershell.anovelidea.org/modulehelp/PoShDynDnsApi/Disconnect-DynDnsSession.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Send-DynDnsSession</maml:linkText> <maml:uri>https://powershell.anovelidea.org/modulehelp/PoShDynDnsApi/Send-DynDnsSession.html</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-DynDnsTask</command:name> <command:verb>Get</command:verb> <command:noun>DynDnsTask</command:noun> <maml:description> <maml:para>The command Get-DynDnsTask retrieves a list of all current DNS API tasks or a single pending API task based on the task ID.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The command Get-DynDnsTask retrieves a list of all current DNS API tasks or a single pending API task based on the task ID.</maml:para> <maml:para>Pending DNS API tasks can be cancelled before they are finished.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-DynDnsTask</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>TaskId</maml:name> <maml:Description> <maml:para>Retrieve a specific task.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>TaskId</maml:name> <maml:Description> <maml:para>Retrieve a specific task.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>DynDnsTask</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-DynDnsTask TaskId : 273365607 Created : 9/13/2018 8:49:24 PM Modified : 9/13/2018 8:49:26 PM CustomerName : thedavecarroll Zone : anovelidea.org TaskName : ProvisionZone Status : complete Message : serving zone Blocking : N Steps : 6 StepCount : 6 Arugments : {} Debug : <truncated> TaskId : 273794012 Created : 9/16/2018 1:29:27 PM Modified : 9/16/2018 1:29:28 PM CustomerName : thedavecarroll Zone : anovelidea.org TaskName : ImportZonefile Status : complete Message : Blocking : N Steps : 0 StepCount : 0 Arugments : {@{name=privileged; value=0}, @{name=name; value=anovelidea.org}} Debug :</dev:code> <dev:remarks> <maml:para>List all tasks for the company.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> Get-DynDnsTask -TaskId 273786284 TaskId : 273786284 Created : 9/16/2018 12:21:35 PM Modified : 9/16/2018 12:21:37 PM CustomerName : thedavecarroll Zone : anovelidea.org TaskName : ShutdownZone Status : complete Message : zone shut down Blocking : N Steps : 0 StepCount : 0 Arugments : {} Debug :</dev:code> <dev:remarks> <maml:para>List the specified task.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://powershell.anovelidea.org/modulehelp/PoShDynDnsApi/Get-DynDnsTask.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get All DNS Tasks (API)</maml:linkText> <maml:uri>https://help.dyn.com/get-all-dns-tasks-api/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get One DNS Task (API)</maml:linkText> <maml:uri>https://help.dyn.com/get-one-dns-task-api/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-DynDnsUser</command:name> <command:verb>Get</command:verb> <command:noun>DynDnsUser</command:noun> <maml:description> <maml:para>The command Get-DynDnsUser retrieves information on a specified user or for all users.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The command Get-DynDnsUser retrieves information on a specified user or for all users.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-DynDnsUser</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="ApiUserName, UserName"> <maml:name>User</maml:name> <maml:Description> <maml:para>The user for which to return information.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="ApiUserName, UserName"> <maml:name>User</maml:name> <maml:Description> <maml:para>The user for which to return information.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>DynDnsUser[]</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------------------------- Example ---------------------------</maml:title> <dev:code>PS C:\> Get-DynDnsUser User : admin Status : active CustomerName : Dave Carroll Nickname : AnotherUser FirstName : David LastName : Carroll Email : admin@anovelidea.org Phone : ###-###-#### Groups : {Default} User : dcarroll Status : active CustomerName : Dave Carroll Nickname : owner FirstName : Dave LastName : Carroll Email : powershell@anovelidea.org Phone : ###-###-#### Groups : {Default}</dev:code> <dev:remarks> <maml:para>Retrieve all users associated with the company.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://powershell.anovelidea.org/modulehelp/PoShDynDnsApi/Get-DynDnsUser.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get User Info (API)</maml:linkText> <maml:uri>https://help.dyn.com/get-user-info-api/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-DynDnsZone</command:name> <command:verb>Get</command:verb> <command:noun>DynDnsZone</command:noun> <maml:description> <maml:para>The command Get-DynDnsZone will return all zones associated with the customer, or the specified zone.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The command Get-DynDnsZone will return all zones associated with the customer, or the specified zone.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-DynDnsZone</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Zone</maml:name> <maml:Description> <maml:para>Specifies a zone for which to retrieve information. If this is omitted, all zones associated with the customer will be returned.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Zone</maml:name> <maml:Description> <maml:para>Specifies a zone for which to retrieve information. If this is omitted, all zones associated with the customer will be returned.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>DynDnsZone[]</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------------------------- Example ---------------------------</maml:title> <dev:code>PS C:\> Get-DynDnsZone Zone SerialNumber SerialStyle Type ---- ------------ ----------- ---- anovelidea.org 2018110400 day Primary</dev:code> <dev:remarks> <maml:para>List all zones associated with the customer.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://powershell.anovelidea.org/modulehelp/PoShDynDnsApi/Get-DynDnsZone.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-DynDnsZone</maml:linkText> <maml:uri>https://powershell.anovelidea.org/modulehelp/PoShDynDnsApi/Add-DynDnsZone.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-DynDnsZone</maml:linkText> <maml:uri>https://powershell.anovelidea.org/modulehelp/PoShDynDnsApi/Remove-DynDnsZone.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get Zone(s) (API)</maml:linkText> <maml:uri>https://help.dyn.com/get-zones-api/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-DynDnsZoneChanges</command:name> <command:verb>Get</command:verb> <command:noun>DynDnsZoneChanges</command:noun> <maml:description> <maml:para>The command Get-DynDnsZoneChanges will retrieve all unpublished changes for the current session for the specified zone.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The command Get-DynDnsZoneChanges will retrieve all unpublished changes for the current session for the specified zone.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-DynDnsZoneChanges</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Zone</maml:name> <maml:Description> <maml:para>Specifies the zone for which to check for pending zone changes.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Zone</maml:name> <maml:Description> <maml:para>Specifies the zone for which to check for pending zone changes.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>DynDnsZoneChanges[]</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------------------------- Example ---------------------------</maml:title> <dev:code>PS C:\> Get-DynDnsZoneChanges -Zone anovelidea.org Zone : anovelidea.org UserId : 389641 Type : TXT Name : newnode.anovelidea.org SerialNumber : 2018110400 TTL : 3600 RecordData : @{rdata_kx=; rdata_srv=; rdata_policy=; rdata_soa=; rdata_key=; rdata_ipseckey=; rdata_cname=; rdata_caa=; rdata_loc=; rdata_spf=; rdata_ptr=; rdata_alias=; rdata_ds=; rdata_naptr=; rdata_sshfp=; rdata_aaaa=; rdata_nsap=; rdata_dhcid=; rdata_dnskey=; rdata_cds=; rdata_txt=; rdata_ns=; rdata_dname=; rdata_csync=; rdata_px=; rdata_a=; rdata_cert=; rdata_rp=; rdata_tlsa=; rdata_mx=; rdata_cdnskey=} Zone : anovelidea.org UserId : 389641 Type : A Name : newnode.anovelidea.org SerialNumber : 2018110400 TTL : 3600 RecordData : @{rdata_kx=; rdata_srv=; rdata_policy=; rdata_soa=; rdata_key=; rdata_ipseckey=; rdata_cname=; rdata_caa=; rdata_loc=; rdata_spf=; rdata_ptr=; rdata_alias=; rdata_ds=; rdata_naptr=; rdata_sshfp=; rdata_aaaa=; rdata_nsap=; rdata_dhcid=; rdata_dnskey=; rdata_cds=; rdata_txt=; rdata_ns=; rdata_dname=; rdata_csync=; rdata_px=; rdata_a=; rdata_cert=; rdata_rp=; rdata_tlsa=; rdata_mx=; rdata_cdnskey=}</dev:code> <dev:remarks> <maml:para>Lists all pending zone changes for the zone anovelidea.org for the current session.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://powershell.anovelidea.org/modulehelp/PoShDynDnsApi/Get-DynDnsZoneChanges.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Publish-DynDnsZoneChanges</maml:linkText> <maml:uri>https://powershell.anovelidea.org/modulehelp/PoShDynDnsApi/Publish-DynDnsZoneChanges.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Undo-DynDnsZoneChanges</maml:linkText> <maml:uri>https://powershell.anovelidea.org/modulehelp/PoShDynDnsApi/Undo-DynDnsZoneChanges.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get Zone ChangeSet (API)</maml:linkText> <maml:uri>https://help.dyn.com/get-zone-changeset-api/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-DynDnsZoneNotes</command:name> <command:verb>Get</command:verb> <command:noun>DynDnsZoneNotes</command:noun> <maml:description> <maml:para>The Get-DynDnsZoneNotes command generates a report containing the Zone Notes for the specified zone.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Get-DynDnsZoneNotes command generates a report containing the Zone Notes for the specified zone.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-DynDnsZoneNotes</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Zone</maml:name> <maml:Description> <maml:para>Specifies the name of the zone for which to retrieve the notes.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Limit</maml:name> <maml:Description> <maml:para>Specifies the number of notes to be retrieved. The Dyn Managed REST API returns a maximum of 1000 notes.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>Offset</maml:name> <maml:Description> <maml:para>Specifies the count of the most recent notes to skip. Defaults to 0.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Limit</maml:name> <maml:Description> <maml:para>Specifies the number of notes to be retrieved. The Dyn Managed REST API returns a maximum of 1000 notes.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>Offset</maml:name> <maml:Description> <maml:para>Specifies the count of the most recent notes to skip. Defaults to 0.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Zone</maml:name> <maml:Description> <maml:para>Specifies the name of the zone for which to retrieve the notes.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>DynDnsZoneNote[]</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-DynDnsZoneNotes -Zone anovelidea.org Zone : anovelidea.org Timestamp : 9/16/2018 9:37:12 PM Type : publish User : dcarroll SerialNumber : 2018091701 Note : anovelidea.org add A 74.125.21.121 Test publish from web UI <truncated> Zone : anovelidea.org Timestamp : 9/16/2018 2:43:11 PM Type : task User : dcarroll SerialNumber : 0 Note : Results of ImportZonefile 273800391 (complete): warn_line9 : overrode NS at anovelidea.org. : NS ns1.p01.dynect.net. warn_line10 : overrode NS at anovelidea.org. : NS ns2.p01.dynect.net. warn_line11 : overrode NS at anovelidea.org. : NS ns3.p01.dynect.net. warn_line12 : overrode NS at anovelidea.org. : NS ns4.p01.dynect.net.</dev:code> <dev:remarks> <maml:para>Return all notes for the specified zone.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> Get-DynDnsZoneNotes -Zone anovelidea.org -Limit 1 Zone : anovelidea.org Timestamp : 9/16/2018 9:37:12 PM Type : publish User : dcarroll SerialNumber : 2018091701 Note : anovelidea.org add A 74.125.21.121 Test publish from web UI</dev:code> <dev:remarks> <maml:para>Return the last note for the specified zone.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://powershell.anovelidea.org/modulehelp/PoShDynDnsApi/Get-DynDnsZoneNotes.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get Zone Notes (API)</maml:linkText> <maml:uri>https://help.dyn.com/get-zone-notes-api/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Lock-DynDnsZone</command:name> <command:verb>Lock</command:verb> <command:noun>DynDnsZone</command:noun> <maml:description> <maml:para>The Lock-DynDnsZone command prevents other users from making changes to the zone.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Lock-DynDnsZone command prevents other users from making changes to the zone.</maml:para> <maml:para>The Dyn term for locking a zone is freeze.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Lock-DynDnsZone</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Zone</maml:name> <maml:Description> <maml:para>The zone to lock, or freeze.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>Prompts you for confirmation before running the command.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Shows what would happen if the command runs. The command is not run.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>Prompts you for confirmation before running the command.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Shows what would happen if the command runs. The command is not run.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Zone</maml:name> <maml:Description> <maml:para>The zone to lock, or freeze.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------------------------- Example ---------------------------</maml:title> <dev:code>PS C:\> Lock-DynDnsZone -Zone anovelidea.org -Confirm:$false -Verbose VERBOSE: Performing the operation "freeze zone" on target "anovelidea.org". VERBOSE: API-3.7.11 : INFO : BLL : freeze: Your zone is now frozen</dev:code> <dev:remarks> <maml:para>Lock the specified zone.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://powershell.anovelidea.org/modulehelp/PoShDynDnsApi/Lock-DynDnsZone.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Unlock-DynDnsZone</maml:linkText> <maml:uri>https://powershell.anovelidea.org/modulehelp/PoShDynDnsApi/Unlock-DynDnsZone.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update Zone (API)</maml:linkText> <maml:uri>https://help.dyn.com/update-zone-api/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Freeze / Unfreeze Zone (API)</maml:linkText> <maml:uri>https://help.dyn.com/freeze-unfreeze-zone-api/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-DynDnsRecord</command:name> <command:verb>New</command:verb> <command:noun>DynDnsRecord</command:noun> <maml:description> <maml:para>The New-DynDnsRecord creates DNS record object of the specified type.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The New-DynDnsRecord creates DNS record object of the specified type.</maml:para> <maml:para>The object can be used by Add-DynDnsRecord and Update-DynDnsRecord and other commands.</maml:para> <maml:para>The output depends on the DNS record type and can be any of the following:</maml:para> <maml:para>* A</maml:para> <maml:para>* TXT</maml:para> <maml:para>* CNAME</maml:para> <maml:para>* MX</maml:para> <maml:para>* SRV</maml:para> <maml:para>* PTR</maml:para> <maml:para>* SOA (ResponsiblePerson)</maml:para> <maml:para></maml:para> <maml:para>The Zone and Name properties are populated when returning objects from the service.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-DynDnsRecord</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>CName</maml:name> <maml:Description> <maml:para>Specifies the alias, i.e. fully-qualified domain name, of the zone node.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>TTL</maml:name> <maml:Description> <maml:para>The Time-To-Live (TTL) to be used for the the DNS record.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-DynDnsRecord</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IPv4Address</maml:name> <maml:Description> <maml:para>Specifies the IP address.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IPAddress</command:parameterValue> <dev:type> <maml:name>IPAddress</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>TTL</maml:name> <maml:Description> <maml:para>The Time-To-Live (TTL) to be used for the the DNS record.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-DynDnsRecord</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>MailServer</maml:name> <maml:Description> <maml:para>Specifies a mail server that processes mail for the domain.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Preference</maml:name> <maml:Description> <maml:para>Specifies the preference value used to prioritize mail delivery if multiple mail servers are available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>TTL</maml:name> <maml:Description> <maml:para>The Time-To-Live (TTL) to be used for the the DNS record.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-DynDnsRecord</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Port</maml:name> <maml:Description> <maml:para>Specifies the TCP or UDP port on which the service is to be found.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Priority</maml:name> <maml:Description> <maml:para>Specifies the priority of the target host, lower value means more preferred.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>TTL</maml:name> <maml:Description> <maml:para>The Time-To-Live (TTL) to be used for the the DNS record.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Target</maml:name> <maml:Description> <maml:para>Specifies the canonical hostname of the machine providing the service.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Weight</maml:name> <maml:Description> <maml:para>Specifies the relative weight for records with the same priority, higher value means more preferred.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-DynDnsRecord</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ResponsiblePerson</maml:name> <maml:Description> <maml:para>Specifies the email address of the domain name administrator.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>TTL</maml:name> <maml:Description> <maml:para>The Time-To-Live (TTL) to be used for the the DNS record.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-DynDnsRecord</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>TTL</maml:name> <maml:Description> <maml:para>The Time-To-Live (TTL) to be used for the the DNS record.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Text</maml:name> <maml:Description> <maml:para>Specifies a string of abritrary text.</maml:para> <maml:para>This is typically used to set the Sender Policy Framework (SPF) record or prove ownership of the zone to a third-party.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>CName</maml:name> <maml:Description> <maml:para>Specifies the alias, i.e. fully-qualified domain name, of the zone node.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IPv4Address</maml:name> <maml:Description> <maml:para>Specifies the IP address.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IPAddress</command:parameterValue> <dev:type> <maml:name>IPAddress</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>MailServer</maml:name> <maml:Description> <maml:para>Specifies a mail server that processes mail for the domain.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Port</maml:name> <maml:Description> <maml:para>Specifies the TCP or UDP port on which the service is to be found.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Preference</maml:name> <maml:Description> <maml:para>Specifies the preference value used to prioritize mail delivery if multiple mail servers are available.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Priority</maml:name> <maml:Description> <maml:para>Specifies the priority of the target host, lower value means more preferred.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ResponsiblePerson</maml:name> <maml:Description> <maml:para>Specifies the email address of the domain name administrator.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>TTL</maml:name> <maml:Description> <maml:para>The Time-To-Live (TTL) to be used for the the DNS record.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Target</maml:name> <maml:Description> <maml:para>Specifies the canonical hostname of the machine providing the service.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Text</maml:name> <maml:Description> <maml:para>Specifies a string of abritrary text.</maml:para> <maml:para>This is typically used to set the Sender Policy Framework (SPF) record or prove ownership of the zone to a third-party.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Weight</maml:name> <maml:Description> <maml:para>Specifies the relative weight for records with the same priority, higher value means more preferred.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>DynDnsRecord</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> New-DynDnsRecord -IPv4Address 172.16.30.9 Address : 172.16.30.9 Zone : Name : Type : A TTL : 0</dev:code> <dev:remarks> <maml:para>Create a DynDnsRecord_A object.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> New-DynDnsRecord -Text 'Authorization text' Strings : {Authorization text} Zone : Name : Type : TXT TTL : 0</dev:code> <dev:remarks> <maml:para>Create a DynDnsRecord_TXT object.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>PS C:\> New-DynDnsRecord -Target chat.anovelidea.org -Port 443 -Priority 10 -Weight 100 Target : chat.anovelidea.org Port : 443 Priority : 10 Weight : 100 Zone : Name : Type : SRV TTL : 0</dev:code> <dev:remarks> <maml:para>Create a DynDnsRecord_SRV object.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://powershell.anovelidea.org/modulehelp/PoShDynDnsApi/New-DynDnsRecord.html</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Publish-DynDnsZoneChanges</command:name> <command:verb>Publish</command:verb> <command:noun>DynDnsZoneChanges</command:noun> <maml:description> <maml:para>The Publish-DynDnsZoneChanges command publishes pending zone changes.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Publish-DynDnsZoneChanges command publishes pending zone changes, which includes completing the creation of new zones.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Publish-DynDnsZoneChanges</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Zone</maml:name> <maml:Description> <maml:para>Publish pending changes to the specified zone.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Notes</maml:name> <maml:Description> <maml:para>Record any notes for the publication of this zone version, such as a reference number or short text describing why the changes occurred.</maml:para> <maml:para>The text REST-Api-PoSh will be prepended before adding to the zone change record. If the Notes parameter is omitted, the Notes field will only contain REST-Api-PoSh .</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>Prompts you for confirmation before running the command.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:Description> <maml:para>By default, the command will not publish the zone if there are no pending zone changes.</maml:para> <maml:para>In the case of adding a new zone, Dyn does not see it as a change to the zone. Using the -Force parameter will publish the zone.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Shows what would happen if the command runs. The command is not run.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>Prompts you for confirmation before running the command.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:Description> <maml:para>By default, the command will not publish the zone if there are no pending zone changes.</maml:para> <maml:para>In the case of adding a new zone, Dyn does not see it as a change to the zone. Using the -Force parameter will publish the zone.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Notes</maml:name> <maml:Description> <maml:para>Record any notes for the publication of this zone version, such as a reference number or short text describing why the changes occurred.</maml:para> <maml:para>The text REST-Api-PoSh will be prepended before adding to the zone change record. If the Notes parameter is omitted, the Notes field will only contain REST-Api-PoSh .</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Shows what would happen if the command runs. The command is not run.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Zone</maml:name> <maml:Description> <maml:para>Publish pending changes to the specified zone.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>DynDnsZone</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Publish-DynDnsZoneChanges -Zone anovelidea.org -Notes 'Add new record to zone.' -Force -Confirm:$false WARNING: There are no pending zone changes. Zone SerialNumber SerialStyle Type ---- ------------ ----------- ---- anovelidea.org 2018091400 day Primary</dev:code> <dev:remarks> <maml:para>Publish the zone changes for the initial creation of a zone.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> Publish-DynDnsZoneChanges -Zone anovelidea.org -Notes 'Initial creation of zone.' -Force -Confirm:$false WARNING: There are no pending zone changes. Zone SerialNumber SerialStyle Type ---- ------------ ----------- ---- anovelidea.org 2018091400 day Primary</dev:code> <dev:remarks> <maml:para>Publish the zone changes to the zone.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://powershell.anovelidea.org/modulehelp/PoShDynDnsApi/Publish-DynDnsZoneChanges.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-DynDnsZoneChanges</maml:linkText> <maml:uri>https://powershell.anovelidea.org/modulehelp/PoShDynDnsApi/Get-DynDnsZoneChanges.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Undo-DynDnsZoneChanges</maml:linkText> <maml:uri>https://powershell.anovelidea.org/modulehelp/PoShDynDnsApi/Undo-DynDnsZoneChanges.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update Zone (API)</maml:linkText> <maml:uri>https://help.dyn.com/update-zone-api/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-DynDnsHttpRedirect</command:name> <command:verb>Remove</command:verb> <command:noun>DynDnsHttpRedirect</command:noun> <maml:description> <maml:para>The command Remove-DynDnsHttpRedirect deletes one or more existing HTTP Redirect services from the zone/node indicated.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The command Remove-DynDnsHttpRedirect deletes one or more existing HTTP Redirect services from the zone/node indicated.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-DynDnsHttpRedirect</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>DynDnsHttpRedirect</maml:name> <maml:Description> <maml:para>One or more DynDnsHttpRedirect objects obtained from the command Get-DynDnsHttpRedirect.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DynDnsHttpRedirect[]</command:parameterValue> <dev:type> <maml:name>DynDnsHttpRedirect[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>Prompts you for confirmation before running the command.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PublishWait</maml:name> <maml:Description> <maml:para>Indicates to wait to publish the deletion of the redirect service until the next zone change.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Shows what would happen if the command runs. The command is not run.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>Prompts you for confirmation before running the command.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>DynDnsHttpRedirect</maml:name> <maml:Description> <maml:para>One or more DynDnsHttpRedirect objects obtained from the command Get-DynDnsHttpRedirect.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DynDnsHttpRedirect[]</command:parameterValue> <dev:type> <maml:name>DynDnsHttpRedirect[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PublishWait</maml:name> <maml:Description> <maml:para>Indicates to wait to publish the deletion of the redirect service until the next zone change.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Shows what would happen if the command runs. The command is not run.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>DynDnsHttpRedirect[]</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-DynDnsHttpRedirect -Zone anovelidea.org | Remove-DynDnsHttpRedirect WARNING: This will autopublish the HTTP redirect deletion to the zone. Zone : anovelidea.org Name : myredirect.anovelidea.org Url : http://www.anovelidea.org ResponseCode : 301 IncludeUri : True Confirm Are you sure you want to perform this action? Performing the operation "Delete HTTP redirect" on target "http://www.anovelidea.org". [Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"): y</dev:code> <dev:remarks> <maml:para>Retrieve all HTTP redirects and delete the ones indicated.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://powershell.anovelidea.org/modulehelp/PoShDynDnsApi/Remove-DynDnsHttpRedirect.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-DynDnsHttpRedirect</maml:linkText> <maml:uri>https://powershell.anovelidea.org/modulehelp/PoShDynDnsApi/Get-DynDnsHttpRedirect.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get HTTP Redirect (API)</maml:linkText> <maml:uri>https://help.dyn.com/get-http-redirect-api/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Delete HTTP Redirect (API)</maml:linkText> <maml:uri>https://help.dyn.com/delete-http-redirect-api/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-DynDnsNode</command:name> <command:verb>Remove</command:verb> <command:noun>DynDnsNode</command:noun> <maml:description> <maml:para>The command Remove-DynDnsNode removes the indicated node, any records within the node, and any nodes underneath the node.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The command Remove-DynDnsNode removes the indicated node, any records within the node, and any nodes underneath the node. NOTE: Use this method ONLY for cleaning up a zone. Regular node or record deletes should use the Delete A Records (API) method. Once all node records are removed, the node is automatically removed.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-DynDnsNode</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Zone</maml:name> <maml:Description> <maml:para>The zone in which to delete the specified node, records, and child nodes.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Node</maml:name> <maml:Description> <maml:para>A node in the specified zone. If the node does not end with the domain of the zone, it will be appended.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>Prompts you for confirmation before running the command.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:Description> <maml:para>The -Force switch is required if the node contains any records or other nodes. When provided, it will allow the deletion of the node and all records and nodes it contains.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Shows what would happen if the command runs. The command is not run.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>Prompts you for confirmation before running the command.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:Description> <maml:para>The -Force switch is required if the node contains any records or other nodes. When provided, it will allow the deletion of the node and all records and nodes it contains.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Node</maml:name> <maml:Description> <maml:para>A node in the specified zone. If the node does not end with the domain of the zone, it will be appended.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Shows what would happen if the command runs. The command is not run.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Zone</maml:name> <maml:Description> <maml:para>The zone in which to delete the specified node, records, and child nodes.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------------------------- Example ---------------------------</maml:title> <dev:code>PS C:\> Remove-DynDnsNode -Zone anovelidea.org -Node newnode.anovelidea.org WARNING: The node (newnode.anovelidea.org) contains records or services. Use the -Force switch if you wish to proceed. PS C:\> Remove-DynDnsNode -Zone anovelidea.org -Node newnode.anovelidea.org -Force -------------------------------------------------------------------------------- PROCEEDING WILL DELETE ALL RECORDS AND SERVICES CONTAINED WITHIN THE NODE THIS INCLUDES ALL CHILD NODES -------------------------------------------------------------------------------- Zone records for newnode.anovelidea.org: ---------------------------------------- Strings : {NewTest} Zone : anovelidea.org Name : newnode.anovelidea.org Type : TXT TTL : 3600 Address : 127.0.0.1 Zone : anovelidea.org Name : newnode.anovelidea.org Type : A TTL : 3600 -------------------------------------------------------------------------------- Confirm Are you sure you want to perform this action? Performing the operation "Delete node, child nodes, and all records" on target "newnode.anovelidea.org". [Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"): y</dev:code> <dev:remarks> <maml:para>Remove the node newnode.anovelidea.org from the zone anovelidea.org. The example illustrates that the -Force switch must be used if the node contains any records or child nodes.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://powershell.anovelidea.org/modulehelp/PoShDynDnsApi/Remove-DynDnsNode.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-DynDnsNodeList</maml:linkText> <maml:uri>https://powershell.anovelidea.org/modulehelp/PoShDynDnsApi/Get-DynDnsNodeList.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Delete Zone Node (API)</maml:linkText> <maml:uri>https://help.dyn.com/delete-zone-node-api/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-DynDnsRecord</command:name> <command:verb>Remove</command:verb> <command:noun>DynDnsRecord</command:noun> <maml:description> <maml:para>The command Remove-DynDnsRecord deletes one or all records of the specified type from a specified zone/node.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The command Remove-DynDnsRecord deletes one or all records of the specified type from a specified zone/node.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-DynDnsRecord</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>DynDnsRecord</maml:name> <maml:Description> <maml:para>One or more DNS records retrieved by the command Get-DynDnsRecord.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DynDnsRecord[]</command:parameterValue> <dev:type> <maml:name>DynDnsRecord[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>Prompts you for confirmation before running the command.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Shows what would happen if the command runs. The command is not run.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>Prompts you for confirmation before running the command.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>DynDnsRecord</maml:name> <maml:Description> <maml:para>One or more DNS records retrieved by the command Get-DynDnsRecord.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DynDnsRecord[]</command:parameterValue> <dev:type> <maml:name>DynDnsRecord[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Shows what would happen if the command runs. The command is not run.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>DynDnsRecord[]</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Get-DynDnsRecord -RecordType A -Node newtest | Remove-DynDnsRecord Address : 216.146.46.11 Zone : anovelidea.org Name : newtest.anovelidea.org Type : A TTL : 60 Confirm Are you sure you want to perform this action? Performing the operation "Delete DNS A record" on target "newtest.anovelidea.org". [Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"): y Address : 216.146.46.10 Zone : anovelidea.org Name : newtest.anovelidea.org Type : A TTL : 60 Confirm Are you sure you want to perform this action? Performing the operation "Delete DNS A record" on target "newtest.anovelidea.org". [Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"): n</dev:code> <dev:remarks> <maml:para>Retrieve all A records for the node newtest.anovelidea.org and delete the first record.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://powershell.anovelidea.org/modulehelp/PoShDynDnsApi/Remove-DynDnsRecord.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-DynDnsRecord</maml:linkText> <maml:uri>https://powershell.anovelidea.org/modulehelp/PoShDynDnsApi/Get-DynDnsRecord.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-DynDnsRecord</maml:linkText> <maml:uri>https://powershell.anovelidea.org/modulehelp/PoShDynDnsApi/Add-DynDnsRecord.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update-DynDnsRecord</maml:linkText> <maml:uri>https://powershell.anovelidea.org/modulehelp/PoShDynDnsApi/Update-DynDnsRecord.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Delete A Records (API)</maml:linkText> <maml:uri>https://help.dyn.com/delete-a-records-api/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Delete CNAME Records (API)</maml:linkText> <maml:uri>https://help.dyn.com/delete-cname-records-api/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Delete MX Records (API)</maml:linkText> <maml:uri>https://help.dyn.com/delete-mx-records-api/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Delete PTR Records (API)</maml:linkText> <maml:uri>https://help.dyn.com/delete-ptr-records-api/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Delete SRV Records (API)</maml:linkText> <maml:uri>https://help.dyn.com/delete-srv-records-api/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Delete TXT Records (API)</maml:linkText> <maml:uri>https://help.dyn.com/delete-txt-records-api/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-DynDnsZone</command:name> <command:verb>Remove</command:verb> <command:noun>DynDnsZone</command:noun> <maml:description> <maml:para>The Remove-DynDnsZone command immediately deletes the primary DNS zone from the customer's Dyn DNS Managed account.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Remove-DynDnsZone command immediately deletes the primary DNS zone from the customer's Dyn DNS Managed account.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-DynDnsZone</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Zone</maml:name> <maml:Description> <maml:para>The name of the zone to delete.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>Prompts you for confirmation before running the command.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Shows what would happen if the command runs. The command is not run.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>Prompts you for confirmation before running the command.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Shows what would happen if the command runs. The command is not run.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Zone</maml:name> <maml:Description> <maml:para>The name of the zone to delete.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Remove-DynDnsZone -Zone anovelidea.org Confirm Are you sure you want to perform this action? Performing the operation "Delete DNS zone and all its records" on target "anovelidea.org". [Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"): y</dev:code> <dev:remarks> <maml:para>Delete the zone.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://powershell.anovelidea.org/modulehelp/PoShDynDnsApi/Remove-DynDnsZone.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-DynDnsZone</maml:linkText> <maml:uri>https://powershell.anovelidea.org/modulehelp/PoShDynDnsApi/Get-DynDnsZone.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-DynDnsZone</maml:linkText> <maml:uri>https://powershell.anovelidea.org/modulehelp/PoShDynDnsApi/Add-DynDnsZone.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Delete One Zone (API)</maml:linkText> <maml:uri>https://help.dyn.com/delete-one-zone-api/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Send-DynDnsSession</command:name> <command:verb>Send</command:verb> <command:noun>DynDnsSession</command:noun> <maml:description> <maml:para>The Send-DynDnsSession command extends the current session with the Dyn Managed DNS REST API.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Send-DynDnsSession command extends the current session with the Dyn Managed DNS REST API.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Send-DynDnsSession</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------------------------- Example ---------------------------</maml:title> <dev:code>PS C:\> Send-DynDnsSession</dev:code> <dev:remarks> <maml:para>Extends the current session.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://powershell.anovelidea.org/modulehelp/PoShDynDnsApi/Send-DynDnsSession.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-DynDnsSession</maml:linkText> <maml:uri>https://powershell.anovelidea.org/modulehelp/PoShDynDnsApi/Connect-DynDnsSession.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Disconnect-DynDnsSession</maml:linkText> <maml:uri>https://powershell.anovelidea.org/modulehelp/PoShDynDnsApi/Disconnect-DynDnsSession.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Test-DynDnsSession</maml:linkText> <maml:uri>https://powershell.anovelidea.org/modulehelp/PoShDynDnsApi/Test-DynDnsSession.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-DynDnsSession</maml:linkText> <maml:uri>https://powershell.anovelidea.org/modulehelp/PoShDynDnsApi/Get-DynDnsSession.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Session Keep Alive (API)</maml:linkText> <maml:uri>https://help.dyn.com/session-keep-alive/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Test-DynDnsSession</command:name> <command:verb>Test</command:verb> <command:noun>DynDnsSession</command:noun> <maml:description> <maml:para>The Test-DynDnsSession command verifies that a session is still active with the Dyn Managed DNS REST API.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Test-DynDnsSession command verifies that a session is still active with the Dyn Managed DNS REST API.</maml:para> <maml:para>If there is no authentication token session variable, this will return False.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Test-DynDnsSession</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Boolean</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------------------------- Example ---------------------------</maml:title> <dev:code>PS C:\> Test-DynDnsSession True</dev:code> <dev:remarks> <maml:para>Verify if there is an active, valid session.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://powershell.anovelidea.org/modulehelp/PoShDynDnsApi/Test-DynDnsSession.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Connect-DynDnsSession</maml:linkText> <maml:uri>https://powershell.anovelidea.org/modulehelp/PoShDynDnsApi/Connect-DynDnsSession.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Disconnect-DynDnsSession</maml:linkText> <maml:uri>https://powershell.anovelidea.org/modulehelp/PoShDynDnsApi/Disconnect-DynDnsSession.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Send-DynDnsSession</maml:linkText> <maml:uri>https://powershell.anovelidea.org/modulehelp/PoShDynDnsApi/Send-DynDnsSession.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-DynDnsSession</maml:linkText> <maml:uri>https://powershell.anovelidea.org/modulehelp/PoShDynDnsApi/Get-DynDnsSession.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Session Active (API)</maml:linkText> <maml:uri>https://help.dyn.com/session-active/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Undo-DynDnsZoneChanges</command:name> <command:verb>Undo</command:verb> <command:noun>DynDnsZoneChanges</command:noun> <maml:description> <maml:para>The Undo-DynDnsZoneChanges deletes changes to the specified zone that have been created during the current session, but not yet published to the zone.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Undo-DynDnsZoneChanges deletes changes to the specified zone that have been created during the current session, but not yet published to the zone.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Undo-DynDnsZoneChanges</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Zone</maml:name> <maml:Description> <maml:para>Delete pending changes to the specified zone.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>Prompts you for confirmation before running the command.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:Description> <maml:para>Perform the operation regardless is there are pending zone changes.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Shows what would happen if the command runs. The command is not run.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>Prompts you for confirmation before running the command.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Force</maml:name> <maml:Description> <maml:para>Perform the operation regardless is there are pending zone changes.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Shows what would happen if the command runs. The command is not run.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Zone</maml:name> <maml:Description> <maml:para>Delete pending changes to the specified zone.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> Undo-DynDnsZoneChanges -Zone anovelidea.org -Confirm:$false user_id : 389641 zone : anovelidea.org rdata_type : A fqdn : www3.anovelidea.org rdata : @{rdata_kx=; rdata_srv=; rdata_policy=; rdata_soa=; rdata_key=; rdata_ipseckey=; rdata_cname=; rdata_caa=; rdata_loc=; rdata_spf=; rdata_ptr=; rdata_alias=; rdata_ds=; rdata_naptr=; rdata_sshfp=; rdata_aaaa=; rdata_nsap=; rdata_dhcid=; rdata_dnskey=; rdata_cds=; rdata_txt=; rdata_ns=; rdata_dname=; rdata_csync=; rdata_px=; rdata_a=; rdata_cert=; rdata_rp=; rdata_tlsa=; rdata_mx=; rdata_cdnskey=} ttl : 3600 serial : 2018091702 id : 516095367</dev:code> <dev:remarks> <maml:para>Delete the pending changes for the specified zone.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> Undo-DynDnsZoneChanges -Zone anovelidea.org -Confirm:$false -Force -Verbose VERBOSE: API-3.7.11 : INFO : BLL : publish: You have not made any changes to this zone WARNING: There are no pending zone changes. VERBOSE: -Force switch used. VERBOSE: Performing the operation "discard zone changes" on target "anovelidea.org". VERBOSE: API-3.7.11 : INFO : BLL : discard: 0 zone changes discarded</dev:code> <dev:remarks> <maml:para>Delete the pending changes for the specified zone, showing when no changes are pending.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://powershell.anovelidea.org/modulehelp/PoShDynDnsApi/Undo-DynDnsZoneChanges.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-DynDnsZoneChanges</maml:linkText> <maml:uri>https://powershell.anovelidea.org/modulehelp/PoShDynDnsApi/Get-DynDnsZoneChanges.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Publish-DynDnsZoneChanges</maml:linkText> <maml:uri>https://powershell.anovelidea.org/modulehelp/PoShDynDnsApi/Publish-DynDnsZoneChanges.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Delete Zone ChangeSet (API)</maml:linkText> <maml:uri>https://help.dyn.com/delete-zone-change-set-api/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Unlock-DynDnsZone</command:name> <command:verb>Unlock</command:verb> <command:noun>DynDnsZone</command:noun> <maml:description> <maml:para>The Unlock-DynDnsZone command removes the restriction that prevents other users from making changes to the zone.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Unlock-DynDnsZone command removes the restriction that prevents other users from making changes to the zone.</maml:para> <maml:para>The Dyn term for unlocking a zone is thaw.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Unlock-DynDnsZone</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Zone</maml:name> <maml:Description> <maml:para>The zone to unlock, or thaw.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>Prompts you for confirmation before running the command.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Shows what would happen if the command runs. The command is not run.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>Prompts you for confirmation before running the command.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Shows what would happen if the command runs. The command is not run.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Zone</maml:name> <maml:Description> <maml:para>The zone to unlock, or thaw.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------------------------- Example ---------------------------</maml:title> <dev:code>PS C:\> Unlock-DynDnsZone -Zone anovelidea.org -Confirm:$false -Verbose VERBOSE: Performing the operation "thaw zone" on target "anovelidea.org". VERBOSE: API-3.7.11 : INFO : BLL : thaw: Your zone is now thawed, you may edit normally</dev:code> <dev:remarks> <maml:para>Unlock the specified zone.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://powershell.anovelidea.org/modulehelp/PoShDynDnsApi/Unlock-DynDnsZone.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Lock-DynDnsZone</maml:linkText> <maml:uri>https://powershell.anovelidea.org/modulehelp/PoShDynDnsApi/Lock-DynDnsZone.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update Zone (API)</maml:linkText> <maml:uri>https://help.dyn.com/update-zone-api/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Freeze / Unfreeze Zone (API)</maml:linkText> <maml:uri>https://help.dyn.com/freeze-unfreeze-zone-api/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Update-DynDnsRecord</command:name> <command:verb>Update</command:verb> <command:noun>DynDnsRecord</command:noun> <maml:description> <maml:para>The Update-DynDnsRecord command updates an existing DNS record in the specified zone.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Update-DynDnsRecord command updates an existing DNS record in the specified zone.</maml:para> <maml:para>Currently, the following DNS record types are supported:</maml:para> <maml:para>* A</maml:para> <maml:para>* TXT</maml:para> <maml:para>* CNAME</maml:para> <maml:para>* MX</maml:para> <maml:para>* SRV</maml:para> <maml:para>* PTR</maml:para> <maml:para>* SOA (ResponsiblePerson)</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Update-DynDnsRecord</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>DynDnsRecord</maml:name> <maml:Description> <maml:para>A DNS record which has prevously been published to the zone of any supported type: A, TXT, CNAME, MX, SRV, PTR, SOA.</maml:para> <maml:para>The value should be created using the Get-DynDnsRecord command.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DynDnsRecord</command:parameterValue> <dev:type> <maml:name>DynDnsRecord</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>UpdatedDynDnsRecord</maml:name> <maml:Description> <maml:para>A valid DNS record of the same type as provided by -DynDnsRecord.</maml:para> <maml:para>The value should be created using the New-DynDnsRecord command.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DynDnsRecord</command:parameterValue> <dev:type> <maml:name>DynDnsRecord</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>Prompts you for confirmation before running the command.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Shows what would happen if the command runs. The command is not run.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:Description> <maml:para>Prompts you for confirmation before running the command.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>DynDnsRecord</maml:name> <maml:Description> <maml:para>A DNS record which has prevously been published to the zone of any supported type: A, TXT, CNAME, MX, SRV, PTR, SOA.</maml:para> <maml:para>The value should be created using the Get-DynDnsRecord command.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DynDnsRecord</command:parameterValue> <dev:type> <maml:name>DynDnsRecord</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>UpdatedDynDnsRecord</maml:name> <maml:Description> <maml:para>A valid DNS record of the same type as provided by -DynDnsRecord.</maml:para> <maml:para>The value should be created using the New-DynDnsRecord command.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DynDnsRecord</command:parameterValue> <dev:type> <maml:name>DynDnsRecord</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:Description> <maml:para>Shows what would happen if the command runs. The command is not run.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>DynDnsRecord</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> $DynDnsRecord = Get-DynDnsRecord -Zone anovelidea.org -RecordType A -Node www2 PS C:\> $UpdatedDynDnsRecord = New-DynDnsRecord -IPv4Address 74.125.21.122 PS C:\> Update-DynDnsRecord -DynDnsRecord $DynDnsRecord -UpdatedDynDnsRecord $UpdatedDynDnsRecord -Confirm:$false Address : 74.125.21.122 Zone : anovelidea.org Name : www2.anovelidea.org Type : A TTL : 3600</dev:code> <dev:remarks> <maml:para>Update the DNS A record for the hostname www2.anovelidea.org.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> $DynDnsRecord = Get-DynDnsRecord -Zone anovelidea.org -RecordType A -Node www2 PS C:\> $UpdatedDynDnsRecord = New-DynDnsRecord -IPv4Address 74.125.21.122 PS C:\> Update-DynDnsRecord -DynDnsRecord $DynDnsRecord -UpdatedDynDnsRecord $UpdatedDynDnsRecord -Confirm:$false -Verbose VERBOSE: The original record type matches the updated record type. VERBOSE: -------------------------------------------------------------------------------- Original DNS Record: Address : 74.125.21.121 Zone : anovelidea.org Name : www2.anovelidea.org Type : A TTL : 3600 VERBOSE: -------------------------------------------------------------------------------- Update DNS Record Attributes:: Attribute Original Updated --------- -------- ------- Address 74.125.21.121 74.125.21.122 -------------------------------------------------------------------------------- VERBOSE: Performing the operation "Update DNS A record" on target "www2.anovelidea.org". VERBOSE: API-3.7.11 : INFO : BLL : update: Record updated Address : 74.125.21.122 Zone : anovelidea.org Name : www2.anovelidea.org Type : A TTL : 3600</dev:code> <dev:remarks> <maml:para>Update the DNS A record for the hostname www2.anovelidea.org. Show the original record and the proposed changes.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://powershell.anovelidea.org/modulehelp/PoShDynDnsApi/Update-DynDnsRecord.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-DynDnsRecord</maml:linkText> <maml:uri>https://powershell.anovelidea.org/modulehelp/PoShDynDnsApi/Add-DynDnsRecord.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-DynDnsRecord</maml:linkText> <maml:uri>https://powershell.anovelidea.org/modulehelp/PoShDynDnsApi/Get-DynDnsRecord.html</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update an A Record (API)</maml:linkText> <maml:uri>https://help.dyn.com/update-a-record-api/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update TXT Record (API)</maml:linkText> <maml:uri>https://help.dyn.com/update-txt-record-api/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update CNAME Records (API)</maml:linkText> <maml:uri>https://help.dyn.com/update-cname-records-api/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update MX Record (API)</maml:linkText> <maml:uri>https://help.dyn.com/update-mx-record-api/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update SRV Records (API)</maml:linkText> <maml:uri>https://help.dyn.com/update-srv-records-api/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update PTR Record (API)</maml:linkText> <maml:uri>https://help.dyn.com/update-ptr-record-api/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Update SOA Record (API)</maml:linkText> <maml:uri>https://help.dyn.com/update-soa-record-api/</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> </helpItems> |