< Back
New-VISamlSecurityContext
Post
NAME New-VISamlSecurityContext
SYNOPSIS
Creates an SAML2 security context object that can be used to authenticate a user with any VMware vCenter Server
services.
SYNTAX
New-VISamlSecurityContext [-VCenterServer] <String> [-IgnoreSslValidationErrors] -OAuthSecurityContext
<OAuth2SecurityContext> [-Port <Int32>] [<CommonParameters>]
DESCRIPTION
Creates an SAML2 security context object that can be used to authenticate a user with any VMware vCenter Server
services.
For more information about security contexts, see the about_security_context (about_security_context.html)article.
This command would authenticate the user who works with OAuth2 security context from an authentication server that
the vCenter Server instance is configured to trust.
PARAMETERS
-IgnoreSslValidationErrors [<SwitchParameter>]
If specified, any errors with the SSL certificate of the server will be ignored.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-OAuthSecurityContext <OAuth2SecurityContext>
Specifies the OAuth2 security context from an authentication server that the vCenter Server instance is
configured to trust.
Required? true
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Port <Int32>
Specifies the port where the vCenter vAPI Endpoint is listening on. The default is 443.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-VCenterServer <String>
Specifies the IP address or the DNS name of the vSphere server that authenticates the user.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByValue)
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
System.String
OUTPUTS
VMware.VimAutomation.ViCore.Types.V1.VISamlSecurityContext
NOTES
-------------------------- Example 1 --------------------------
$oauthCtx = New-VcsOAuthSecurityContext -ApiToken "a3f35067-80b5-44f0-a0bc-e19f2bc17fb7"
$samlCtx = New-VISamlSecurityContext -VCenterServer "Server" -OAuthSecurityContext $oauthCtx
Creates an SAML2 security context object by authenticating the user with an OAuth2 security context from the
VMware Cloud Services authentication server. This SAML2 security context can be used to authenticate the user to
any vCenter Server services running in the VMware Cloud on AWS.
RELATED LINKS
Online Version: https://code.vmware.com/doc/preview?id= ... ntext.html
about_security_context
SYNOPSIS
Creates an SAML2 security context object that can be used to authenticate a user with any VMware vCenter Server
services.
SYNTAX
New-VISamlSecurityContext [-VCenterServer] <String> [-IgnoreSslValidationErrors] -OAuthSecurityContext
<OAuth2SecurityContext> [-Port <Int32>] [<CommonParameters>]
DESCRIPTION
Creates an SAML2 security context object that can be used to authenticate a user with any VMware vCenter Server
services.
For more information about security contexts, see the about_security_context (about_security_context.html)article.
This command would authenticate the user who works with OAuth2 security context from an authentication server that
the vCenter Server instance is configured to trust.
PARAMETERS
-IgnoreSslValidationErrors [<SwitchParameter>]
If specified, any errors with the SSL certificate of the server will be ignored.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-OAuthSecurityContext <OAuth2SecurityContext>
Specifies the OAuth2 security context from an authentication server that the vCenter Server instance is
configured to trust.
Required? true
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Port <Int32>
Specifies the port where the vCenter vAPI Endpoint is listening on. The default is 443.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-VCenterServer <String>
Specifies the IP address or the DNS name of the vSphere server that authenticates the user.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByValue)
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
System.String
OUTPUTS
VMware.VimAutomation.ViCore.Types.V1.VISamlSecurityContext
NOTES
-------------------------- Example 1 --------------------------
$oauthCtx = New-VcsOAuthSecurityContext -ApiToken "a3f35067-80b5-44f0-a0bc-e19f2bc17fb7"
$samlCtx = New-VISamlSecurityContext -VCenterServer "Server" -OAuthSecurityContext $oauthCtx
Creates an SAML2 security context object by authenticating the user with an OAuth2 security context from the
VMware Cloud Services authentication server. This SAML2 security context can be used to authenticate the user to
any vCenter Server services running in the VMware Cloud on AWS.
RELATED LINKS
Online Version: https://code.vmware.com/doc/preview?id= ... ntext.html
about_security_context