Add-ODUConfigOctopusServer

NAME Add-ODUConfigOctopusServer



SYNOPSIS

Sets Octopus Server configuration (root url and API key)





SYNTAX

Add-ODUConfigOctopusServer [-Url] <String> [-ApiKey] <String> [<CommonParameters>]





DESCRIPTION

Sets Octopus Server configuration (root url and API key)

See this for more info about API key: https://octopus.com/docs/api-and-integr ... an-api-key



Note: this function is Add- not Set- because (eventually) ODU will support multiple Octo setups in the

configuration





PARAMETERS

-Url <String>

Root url of Octopus server



Required? true

Position? 1

Default value

Accept pipeline input? false

Accept wildcard characters? false



-ApiKey <String>

API Key for a specific user account to use for exports



Required? true

Position? 2

Default value

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



OUTPUTS



-------------------------- EXAMPLE 1 --------------------------



PS C:\\>Add-ODUConfigOctopusServer -Url https://MyOctoServer.octopus.app -ApiKey 'API-ABCDEFGH01234567890ABCDEFGH'



<validates then sets url and api key for Octo server>











RELATED LINKS

https://github.com/DTW-DanWard/OctopusDeployUtilities