< Back

Connect-DynDnsSession

Sat Jan 18, 2020 8:14 pm

NAME Connect-DynDnsSession



SYNOPSIS

The Connect-DynDnsSession command creates a new session to the Dyn Managed DNS REST API.





SYNTAX

Connect-DynDnsSession [-User] <String> [-Customer] <String> [-Password] <SecureString> [-Force]

[<CommonParameters>]





DESCRIPTION

The Connect-DynDnsSession command creates a new session to the Dyn Managed DNS REST API.



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.





PARAMETERS

-Customer <String>

The customer name for the Dyn API user.



Required? true

Position? 1

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-Force [<SwitchParameter>]

Discards an existing, valid session before creating a new session.



Required? false

Position? named

Default value False

Accept pipeline input? False

Accept wildcard characters? false



-Password <SecureString>

The Dyn API user password.



Required? true

Position? 2

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-User <String>

The Dyn API user (not DynID).



Required? true

Position? 0

Default value None

Accept pipeline input? False

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS

None







OUTPUTS

None







NOTES









-------------------------- Example 1 --------------------------



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



Connects to the Dyn Managed DNS API using the provided credentials.

-------------------------- Example 2 --------------------------



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



Terminates a current session and creates a new session to the Dyn Managed DNS API using the provided credentials.



RELATED LINKS

Online Version: https://powershell.anovelidea.org/modul ... ssion.html

Disconnect-DynDnsSession https://powershell.anovelidea.org/modul ... ssion.html

Send-DynDnsSession https://powershell.anovelidea.org/modul ... ssion.html

Test-DynDnsSession https://powershell.anovelidea.org/modul ... ssion.html

Get-DynDnsSession https://powershell.anovelidea.org/modul ... ssion.html

Session Log-in (API) https://help.dyn.com/session-log-in/