Skip to main content

New-Session

SYNOPSIS​

Create a new Cumulocity Session

SYNTAX​

New-Session
	[-Host] <String>
	[[-Tenant] <String>]
	[[-Username] <Object>]
	[[-Password] <Object>]
	[[-Name] <String>]
	[[-Mode] <String>]
	[[-LoginType] <String>]
	[[-Description] <String>]
	[[-BrowserCallback] <String>]
	[-NoTenantPrefix]
	[-AllowInsecure]
	[<CommonParameters>]

DESCRIPTION​

Create a new Cumulocity session which can be used by the cmdlets

EXAMPLES​

EXAMPLE 1​

New-Session -Name "develop" -Host "my-tenant-name.eu-latest.cumulocity.com"

Create a new Cumulocity session called develop

EXAMPLE 2​

New-Session -Host "my-tenant-name.eu-latest.cumulocity.com"

Create a new Cumulocity session. It will prompt for the username and password.

PARAMETERS​

-Host​

Host url, i.e. https://my-tenant-name.eu-latest.cumulocity.com

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Tenant​

Tenant id, i.e. t12345

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Username​

Username

Type: Object
Parameter Sets: (All)
Aliases:

Required: False
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Password​

Password

Type: Object
Parameter Sets: (All)
Aliases:

Required: False
Position: 4
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Name​

Name of the Cumulocity session

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 5
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Mode​

Mode. The mode controls which types of commands are enabled

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 6
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-LoginType​

LoginType. Login Type, e.g. BASIC, OAUTH2_INTERNAL, OAUTH2, BROWSER, DEVICE, CERTIFICATE, NONE

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 7
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Description​

Description

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 8
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-BrowserCallback​

Custom redirect URI for the browser authorization code flow, e.g. http://127.0.0.1:8080/callback

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 9
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-NoTenantPrefix​

Don't use tenant name as a prefix to the user name when using Basic Authentication

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-AllowInsecure​

Allow insecure connection (e.g. when using self-signed certificates)

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters​

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS​

OUTPUTS​

None​

NOTES​

https://reubenmiller.github.io/go-c8y-cli/docs/cli/c8y/sessions_create