< Back
Set-EdgeConnection
Post
NAME Set-EdgeConnection
SYNOPSIS
Sets connection information for Apigee Edge administrative actions
SYNTAX
Set-EdgeConnection [[-File] <String>] [[-Org] <String>] [[-User] <String>] [[-Password] <String>]
[[-SsoOneTimePasscode] <String>] [[-SsoZone] <String>] [[-SsoUrl] <String>] [[-LoginClientId] <String>]
[[-LoginClientSecret] <String>] [[-MfaCode] <String>] [[-EncryptedPassword] <String>] [[-MgmtUri] <String>]
[-NoToken] [<CommonParameters>]
DESCRIPTION
Sets connection information, including Organization name, and user credentials, for Apigee Edge administrative
actions.
PARAMETERS
-File <String>
Optional. A file that contains a JSON representation of the connection informtion. Example:
{
"Org" : "myorgname",
"User" : "dchiesa@google.com",
"EncryptedPassword" : "01000000d08c9ddf011....."
}
Required? false
Position? 1
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Org <String>
Optional. Required if File is not specified. This is the Apigee Edge organization.
Required? false
Position? 2
Default value
Accept pipeline input? false
Accept wildcard characters? false
-User <String>
Required. The Apigee Edge administrative user.
Required? false
Position? 3
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Password <String>
Optional. The plaintext password for the Apigee Edge administrative user. Specify this
or the EncryptedPassword.
Required? false
Position? 4
Default value
Accept pipeline input? false
Accept wildcard characters? false
-SsoOneTimePasscode <String>
The one-time passcode returned by ${SSO_URL}/passcode . Use this when Single-sign-on has
been configured for Apigee Edge. In other words, use it when a distinct IdP will authenticate the user. No
password is necessary.
Required? false
Position? 5
Default value
Accept pipeline input? false
Accept wildcard characters? false
-SsoZone <String>
Optional. The SSO Zone for your user. By default there is no zone. This value will affect the SSO Login URL.
If you pass in "zone1" then the login url will become https://zone1.login.apigee.com/ . If you would like
to explicitly specify the SSO URL, then omit this parameter and set the SsoUrl parameter.
Specify at most one of SsoZone and SsoUrl.
Required? false
Position? 6
Default value
Accept pipeline input? false
Accept wildcard characters? false
-SsoUrl <String>
Optional. This defaults to 'https://login.apigee.com'. If you are using SAML Sign in, then specify
https://YOURZONE.login.apigee.com/ for this parameter. Specify at most one of SsoZone and SsoUrl.
Required? false
Position? 7
Default value
Accept pipeline input? false
Accept wildcard characters? false
-LoginClientId <String>
Optional. This defaults to 'edgecli'.
Required? false
Position? 8
Default value edgecli
Accept pipeline input? false
Accept wildcard characters? false
-LoginClientSecret <String>
Optional. This defaults to 'edgeclisecret'.
Required? false
Position? 9
Default value edgeclisecret
Accept pipeline input? false
Accept wildcard characters? false
-MfaCode <String>
Optional. The plaintext MFA code for your user. Used for obtaining a token.
Required? false
Position? 10
Default value
Accept pipeline input? false
Accept wildcard characters? false
-EncryptedPassword <String>
Optional. The encrypted password for the Apigee Edge administrative user. Use this as an
alternative to the Password parameter. To get the encrypted password, you can do this:
$SecurePass = Read-Host -assecurestring "Please enter the password"
$EncryptedString = ConvertFrom-SecureString $SecurePass
Required? false
Position? 11
Default value
Accept pipeline input? false
Accept wildcard characters? false
-MgmtUri <String>
The base Uri for the Edge API Management server.
Default: https://api.enterprise.apigee.com
Required? false
Position? 12
Default value https://api.enterprise.apigee.com
Accept pipeline input? false
Accept wildcard characters? false
-NoToken [<SwitchParameter>]
A switch, to disable obtaining a token.
Required? false
Position? named
Default value False
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:\\>Set-EdgeConnection -Org cap500 -User dino@apigee.com -Password Secret1XYZ
RELATED LINKS
SYNOPSIS
Sets connection information for Apigee Edge administrative actions
SYNTAX
Set-EdgeConnection [[-File] <String>] [[-Org] <String>] [[-User] <String>] [[-Password] <String>]
[[-SsoOneTimePasscode] <String>] [[-SsoZone] <String>] [[-SsoUrl] <String>] [[-LoginClientId] <String>]
[[-LoginClientSecret] <String>] [[-MfaCode] <String>] [[-EncryptedPassword] <String>] [[-MgmtUri] <String>]
[-NoToken] [<CommonParameters>]
DESCRIPTION
Sets connection information, including Organization name, and user credentials, for Apigee Edge administrative
actions.
PARAMETERS
-File <String>
Optional. A file that contains a JSON representation of the connection informtion. Example:
{
"Org" : "myorgname",
"User" : "dchiesa@google.com",
"EncryptedPassword" : "01000000d08c9ddf011....."
}
Required? false
Position? 1
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Org <String>
Optional. Required if File is not specified. This is the Apigee Edge organization.
Required? false
Position? 2
Default value
Accept pipeline input? false
Accept wildcard characters? false
-User <String>
Required. The Apigee Edge administrative user.
Required? false
Position? 3
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Password <String>
Optional. The plaintext password for the Apigee Edge administrative user. Specify this
or the EncryptedPassword.
Required? false
Position? 4
Default value
Accept pipeline input? false
Accept wildcard characters? false
-SsoOneTimePasscode <String>
The one-time passcode returned by ${SSO_URL}/passcode . Use this when Single-sign-on has
been configured for Apigee Edge. In other words, use it when a distinct IdP will authenticate the user. No
password is necessary.
Required? false
Position? 5
Default value
Accept pipeline input? false
Accept wildcard characters? false
-SsoZone <String>
Optional. The SSO Zone for your user. By default there is no zone. This value will affect the SSO Login URL.
If you pass in "zone1" then the login url will become https://zone1.login.apigee.com/ . If you would like
to explicitly specify the SSO URL, then omit this parameter and set the SsoUrl parameter.
Specify at most one of SsoZone and SsoUrl.
Required? false
Position? 6
Default value
Accept pipeline input? false
Accept wildcard characters? false
-SsoUrl <String>
Optional. This defaults to 'https://login.apigee.com'. If you are using SAML Sign in, then specify
https://YOURZONE.login.apigee.com/ for this parameter. Specify at most one of SsoZone and SsoUrl.
Required? false
Position? 7
Default value
Accept pipeline input? false
Accept wildcard characters? false
-LoginClientId <String>
Optional. This defaults to 'edgecli'.
Required? false
Position? 8
Default value edgecli
Accept pipeline input? false
Accept wildcard characters? false
-LoginClientSecret <String>
Optional. This defaults to 'edgeclisecret'.
Required? false
Position? 9
Default value edgeclisecret
Accept pipeline input? false
Accept wildcard characters? false
-MfaCode <String>
Optional. The plaintext MFA code for your user. Used for obtaining a token.
Required? false
Position? 10
Default value
Accept pipeline input? false
Accept wildcard characters? false
-EncryptedPassword <String>
Optional. The encrypted password for the Apigee Edge administrative user. Use this as an
alternative to the Password parameter. To get the encrypted password, you can do this:
$SecurePass = Read-Host -assecurestring "Please enter the password"
$EncryptedString = ConvertFrom-SecureString $SecurePass
Required? false
Position? 11
Default value
Accept pipeline input? false
Accept wildcard characters? false
-MgmtUri <String>
The base Uri for the Edge API Management server.
Default: https://api.enterprise.apigee.com
Required? false
Position? 12
Default value https://api.enterprise.apigee.com
Accept pipeline input? false
Accept wildcard characters? false
-NoToken [<SwitchParameter>]
A switch, to disable obtaining a token.
Required? false
Position? named
Default value False
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:\\>Set-EdgeConnection -Org cap500 -User dino@apigee.com -Password Secret1XYZ
RELATED LINKS