Connect-Rubrik

SYNOPSIS

Connects to Rubrik and retrieves a token value for authentication

SYNTAX

UserPassword (Default)

Connect-Rubrik [-Server] <String> [-Username] <String> [-Password] <SecureString> [-OrganizationID <String>]
 [-UserAgent <Hashtable>] [-WhatIf] [-Confirm] [<CommonParameters>]

Credential

Connect-Rubrik [-Server] <String> [-Credential] <Object> [-OrganizationID <String>] [-UserAgent <Hashtable>]
 [-WhatIf] [-Confirm] [<CommonParameters>]

Token

Connect-Rubrik [-Server] <String> [-Token] <String> [-OrganizationID <String>] [-UserAgent <Hashtable>]
 [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

The Connect-Rubrik function is used to connect to the Rubrik RESTful API and supply credentials to the /login method. Rubrik then returns a unique token to represent the user's credentials for subsequent calls. Acquire a token before running other Rubrik cmdlets. Note that you can pass a username and password or an entire set of credentials.

EXAMPLES

EXAMPLE 1

Connect-Rubrik -Server 192.168.1.1 -Username admin

This will connect to Rubrik with a username of "admin" to the IP address 192.168.1.1. The prompt will request a secure password.

EXAMPLE 2

Connect-Rubrik -Server 192.168.1.1 -Username admin -Password (ConvertTo-SecureString "secret" -asplaintext -force)

If you need to pass the password value in the cmdlet directly, use the ConvertTo-SecureString function.

EXAMPLE 3

Connect-Rubrik -Server 192.168.1.1 -Credential (Get-Credential)

Rather than passing a username and secure password, you can also opt to submit an entire set of credentials using the -Credentials parameter.

EXAMPLE 4

Connect-Rubrik -Server 192.168.1.1 -Token "token key provided by Rubrik"

Rather than passing a username and secure password, you can now generate an API token key in Rubrik. This key can then be used to authenticate instead of a credential or user name and password.

EXAMPLE 5

Connect-Rubrik -Server 192.168.1.1 -Username admin -UserAgent @{platform_integration='Poshbot.Rubrik'}

This will connect to Rubrik with a username of "admin" to the IP address 192.168.1.1, will prompt for password and provide additional information in the user-agent string.

PARAMETERS

-Server

The IP or FQDN of any available Rubrik node within the cluster

Type: String
Parameter Sets: (All)
Aliases:

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

-Username

Username with permissions to connect to the Rubrik cluster Optionally, use the Credential parameter

Type: String
Parameter Sets: UserPassword
Aliases:

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

-Password

Password for the Username provided Optionally, use the Credential parameter

Type: SecureString
Parameter Sets: UserPassword
Aliases:

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

-Credential

Credentials with permission to connect to the Rubrik cluster Optionally, use the Username and Password parameters

Type: Object
Parameter Sets: Credential
Aliases:

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

-Token

Provide the Rubrik API Token instead, these are specificially created API token for authentication.

Type: String
Parameter Sets: Token
Aliases:

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

-OrganizationID

Organization to connect with, assuming the user has multiple organizations

Type: String
Parameter Sets: (All)
Aliases: organization_id

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

-UserAgent

Additional information to be added, takes hashtable as input

Type: Hashtable
Parameter Sets: (All)
Aliases:

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

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi

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

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

Required: False
Position: Named
Default value: None
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

NOTES

Written by Chris Wahl for community usage Twitter: @ChrisWahl GitHub: chriswahl

RELATED LINKS

https://rubrik.gitbook.io/rubrik-sdk-for-powershell/command-documentation/reference/connect-rubrik