Skip to content

Commit 315b766

Browse files
committed
connect-rubrik.md: Document connecting with a service account
1 parent 8c68c71 commit 315b766

File tree

1 file changed

+23
-0
lines changed

1 file changed

+23
-0
lines changed

docs/command-documentation/reference/connect-rubrik.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,13 @@ Connect-Rubrik [-Server] <String> [-Token] <String> [-OrganizationID <String>] [
3030
[-WhatIf] [-Confirm] [<CommonParameters>]
3131
```
3232

33+
### Service Account
34+
```
35+
Connect-Rubrik [-Server] <String> [-Id] <String> [-Secret] <String> [-OrganizationID <String>]
36+
[-UserAgent <Hashtable>] [-WhatIf] [-Confirm] [-RedirectToRSC] [<CommonParameters>]
37+
38+
```
39+
3340
## DESCRIPTION
3441
The Connect-Rubrik function is used to connect to the Rubrik RESTful API and supply credentials to the /login method.
3542
Rubrik then returns a unique token to represent the user's credentials for subsequent calls.
@@ -75,6 +82,22 @@ Connect-Rubrik -Server 192.168.1.1 -Username admin -UserAgent @{platform_integra
7582

7683
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.
7784

85+
### EXAMPLE 6
86+
```
87+
Connect-Rubrik -Server 192.168.1.1 -Id "Service Account ID" -Secret "Service Account Secret"
88+
```
89+
90+
Connect to Rubrik cluster utilizing a Service Account ID and Secret
91+
92+
### EXAMPLE 7
93+
```
94+
Connect-Rubrik -Server 192.168.1.1 -Id "Service Account ID" -Secret "Service Account Secret" -RedirectToRSC
95+
```
96+
97+
Connect to Rubrik cluster utilizing a Service Account ID and Secret, redirecting certain cmdlets to utilized RSC GraphQL
98+
APIs where appropriate.
99+
100+
78101
## PARAMETERS
79102

80103
### -Server

0 commit comments

Comments
 (0)