Skip to content

Commit

Permalink
V2.2.0 - New release, see release notes
Browse files Browse the repository at this point in the history
  • Loading branch information
atkinsroy committed May 31, 2023
2 parents aa4cc25 + a761f20 commit 3dfd414
Show file tree
Hide file tree
Showing 65 changed files with 2,803 additions and 2,416 deletions.
7 changes: 1 addition & 6 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,7 +1,2 @@
New-Manifest.ps1
UtilityScripts/Run-Coverage.ps1
UtilityScripts/HPEsimpliVity.Tests.ps1
UtilityScripts/SignCode.ps1
UtilityScripts/New-Docs.ps1
UtilityScripts/README.internal.md
Build/
Signed/
69 changes: 31 additions & 38 deletions Docs/Connect-Svt.md
Original file line number Diff line number Diff line change
@@ -1,72 +1,66 @@
---
external help file: HPESimpliVity-help.xml
Module Name: HPESimpliVity
Module Name: hpesimplivity
online version: https://github.com/atkinsroy/HPESimpliVity/blob/master/docs/Connect-Svt.md
schema: 2.0.0
---

# Connect-Svt

## SYNOPSIS

Connect to a HPE SimpliVity Virtual Appliance (SVA) or Managed Virtual Appliance (MVA)

## SYNTAX

```PowerShell
```
Connect-Svt [-VirtualAppliance] <String> [[-Credential] <PSCredential>] [-SignedCert] [<CommonParameters>]
```

## DESCRIPTION

To access the SimpliVity REST API, you need to request an authentication token by issuing a request
using the OAuth authentication method. Once obtained, you can pass the resulting access token via the
using the OAuth authentication method.
Once obtained, you can pass the resulting access token via the
HTTP header using an Authorisation Bearer token.

The access token is stored in a global variable accessible to all HPESimpliVity cmdlets in the PowerShell session.
Note that the access token times out after 10 minutes of inactivity. However, the HPESimpliVity module will automatically recreate a new token using cached credentials.
The access token is stored in a global variable called $SvtConnection and is accessible to all HPESimpliVity
cmdlets in the PowerShell session.
Note that the access token times out after 10 minutes of inactivity.
However,
the HPESimpliVity module will automatically recreate a new token using cached credentials.

## EXAMPLES

### EXAMPLE 1

```PowerShell
```
Connect-Svt -VirtualAppliance <FQDN or IP Address of SVA or MVA>
```

This will securely prompt you for credentials

### EXAMPLE 2

```PowerShell
```
$Cred = Get-Credential -Message 'Enter Credentials'
PS C:\> Connect-Svt -VA <FQDN or IP Address of SVA or MVA> -Credential $Cred
PS C:\> Connect-Svt -VA 10.1.1.16 -Credential $Cred
```

Create the credential first, then pass it as a parameter.

### EXAMPLE 3

```PowerShell
```
$CredFile = "$((Get-Location).Path)\SvaCred.XML"
PS C:\> Get-Credential -Credential '<username@domain>'| Export-CLIXML $CredFile
PS C:\> $Cred = Import-CLIXML $CredFile
PS C:\> Connect-Svt -VA <FQDN or IP Address of SVA or MVA> -Credential $Cred
```

Another way is to store the credential in a file (as above), then connect to the SVA using:
PS C:\\\> Connect-Svt -VA \<FQDN or IP Address of SVA or MVA\> -Credential $(Import-CLIXML $CredFile)

or:
PS C:\\\> $Cred = Import-CLIXML $CredFile
PS C:\\\> Connect-Svt -VA \<FQDN or IP Address of SVA or MVA\> -Credential $Cred

This method is useful in non-interactive sessions.
Once the file is created, run the Connect-Svt
command to connect and reconnect to the SVA, as required.
Save credential to a file for later use (first 2 commands).
This method is useful in non-interactive sessions.
Once the file is created, run the Connect-Svt command to connect and reconnect to the SVA, as required (last 2
commands).

## PARAMETERS

### -VirtualAppliance

The Fully Qualified Domain Name (FQDN) or IP address of any SimpliVity Virtual Appliance or Managed Virtual
Appliance in the SimpliVity Federation.

Expand All @@ -83,11 +77,13 @@ Accept wildcard characters: False
```
### -Credential
User generated credential as System.Management.Automation.PSCredential.
Use the Get-Credential PowerShell cmdlet to create the credential.
This can optionally be imported from a file in cases where you are invoking non-interactively.
E.g. shutting down the SVAs from a script invoked by UPS software.
Use the Get-Credential
PowerShell cmdlet to create the credential.
This can optionally be imported from a file in cases where
you are invoking non-interactively.
E.g.
shutting down the SVAs from a script invoked by UPS software.
```yaml
Type: PSCredential
Expand All @@ -102,11 +98,12 @@ Accept wildcard characters: False
```
### -SignedCert
Requires a trusted certificate to enable TLS1.2.
By default, the cmdlet allows untrusted certificates with HTTPS connections.
By default, the cmdlet allows untrusted certificates with
HTTPS connections.
This is, most commonly, a self-signed certificate.
Alternatively it could be a certificate issued from an untrusted certificate authority, such as an internal CA.
Alternatively it could be a
certificate issued from an untrusted certificate authority, such as an internal CA.
```yaml
Type: SwitchParameter
Expand All @@ -121,23 +118,19 @@ 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](http://go.microsoft.com/fwlink/?LinkID=113216).
## INPUTS
### System.String
### System.Management.Automation.PSCredential
## OUTPUTS
### System.Management.Automation.PSCustomObject
## NOTES
Author: Roy Atkins, HPE Pointnext Services
Author: Roy Atkins, HPE Services
## RELATED LINKS
[https://github.com/atkinsroy/HPESimpliVity/blob/master/docs/Connect-Svt.md](https://github.com/atkinsroy/HPESimpliVity/blob/master/docs/Connect-Svt.md)
39 changes: 17 additions & 22 deletions Docs/Copy-SvtBackup.md
Original file line number Diff line number Diff line change
@@ -1,55 +1,55 @@
---
external help file: HPESimpliVity-help.xml
Module Name: HPESimpliVity
Module Name: hpesimplivity
online version: https://github.com/atkinsroy/HPESimpliVity/blob/master/docs/Copy-SvtBackup.md
schema: 2.0.0
---

# Copy-SvtBackup

## SYNOPSIS

Copy HPE SimpliVity backups to another cluster or to an external store

## SYNTAX

```PowerShell
```
Copy-SvtBackup [-DestinationName] <String> [-BackupId] <String> [<CommonParameters>]
```

## DESCRIPTION

Copy HPE SimpliVity backups between SimpliVity clusters and backups to and from external stores.

Note that currently backups on external stores can only be copied to the cluster they were backed up from.
Note that currently backups on external stores can only be copied to the cluster they were backed
up from.
In addition, a backup on an external store cannot be copied to another external store.

If you try to copy a backup to a destination where it already exists, the task will fail with a "Duplicate
name exists" message.

BackupId is the only unique identifier for backup objects (i.e. backups for each VM have the same name). This makes using this command a little cumbersome by itself. However, you can use Get-SvtBackup to identify the backups you want to target and then pass the output to this command.
BackupId is the only unique identifier for backup objects (i.e.
backups for each VM have the same name).
This makes using this command a little cumbersome by itself.
However, you can use Get-SvtBackup to
identify the backups you want to target and then pass the output to this command.

## EXAMPLES

### EXAMPLE 1

```PowerShell
Get-SvtBackup -VmName Server2016-01 | Copy-SvtBackup -DestinationName Cluster02
```
Get-SvtBackup -VmName Win2019-01 | Copy-SvtBackup -DestinationName Cluster02
```

Copy the last 24 hours of backups for the specified VM to the specified SimpliVity cluster

### EXAMPLE 2

```PowerShell
```
Get-SvtBackup -Hour 2 | Copy-SvtBackup Cluster02
```

Copy the last two hours of all backups to the specified cluster

### EXAMPLE 3

```PowerShell
```
Get-SvtBackup -Name 'BeforeSQLupgrade' | Copy-SvtBackup -DestinationName StoreOnce-Data02
```

Expand All @@ -58,9 +58,9 @@ Copy backups with the specified name to the specified external store.
## PARAMETERS

### -DestinationName

Specify the destination SimpliVity Cluster name or external store name.
If a cluster exists with the same name as an external store, the cluster wins.
If a cluster exists with the
same name as an external store, the cluster wins.

```yaml
Type: String
Expand All @@ -75,7 +75,6 @@ Accept wildcard characters: False
```
### -BackupId
Specify the Backup ID(s) to copy.
Use the output from an appropriate Get-SvtBackup command to provide
one or more Backup ID's to copy.
Expand All @@ -93,23 +92,19 @@ 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](http://go.microsoft.com/fwlink/?LinkID=113216).
## INPUTS
### System.String
### HPE.SimpliVity.Backup
## OUTPUTS
### HPE.SimpliVity.Task
## NOTES
Author: Roy Atkins, HPE Pointnext Services
Author: Roy Atkins, HPE Services
## RELATED LINKS
[https://github.com/atkinsroy/HPESimpliVity/blob/master/docs/Copy-SvtBackup.md](https://github.com/atkinsroy/HPESimpliVity/blob/master/docs/Copy-SvtBackup.md)
Loading

0 comments on commit 3dfd414

Please sign in to comment.