< Back
Set-OVGDAppliance
Post
NAME Set-OVGDAppliance
SYNOPSIS
Perform changes to a OneView appliance
SYNTAX
Set-OVGDAppliance [-Server <Object>] -Entity <Object> [-NewName <Object>] [-WhatIf] [-Confirm] [<CommonParameters>]
Set-OVGDAppliance [-Server <Object>] -Entity <Object> [-Refresh] [-WhatIf] [-Confirm] [<CommonParameters>]
Set-OVGDAppliance [-Server <Object>] -Entity <Object> [-Reconnect] [-Username <Object>] [-Password <SecureString>]
[-LoginDomain <Object>] [-WhatIf] [-Confirm] [<CommonParameters>]
DESCRIPTION
This function can perform the following changes on a OneView appliance on the connected Global Dashboard instance:
- Change name
- Refresh the connection to the OneView appliance
- Reconnect the OneView appliance
PARAMETERS
-Server <Object>
The Global Dashboard to work with, defaults to the Global variable OVGDPSServer
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Entity <Object>
The Id of the OneView appliance to work with
Required? true
Position? named
Default value
Accept pipeline input? true (ByValue)
Accept wildcard characters? false
-NewName <Object>
Set a new name for the OneView appliance
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Refresh [<SwitchParameter>]
Refresh the connection to the specified OneView appliance
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-Reconnect [<SwitchParameter>]
Reconnect to the specified OneView appliance
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-Username <Object>
The Username of a user with access to the Global Dashboard instance
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Password <SecureString>
The Password of the specified user
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-LoginDomain <Object>
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
Required? false
Position? named
Default value
Accept pipeline input? false
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
OUTPUTS
NOTES
Info
Author : Rudi Martinsen / Intility AS
Date : 25/03-2019
Version : 0.3.1
Revised : 17/04-2019
Changelog:
0.3.1 -- Added help text
0.3.0 -- Added reconnect
0.2.0 -- Added refresh
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>Set-OVGDAppliance -Entity xxxxxxxx-xxxx-xxxx-xxxx-1b2841850e85 -NewName newname-001
Renames the specified appliance to "newname-001" on the Global Dashboard instance
-------------------------- EXAMPLE 2 --------------------------
PS C:\\>Set-OVGDAppliance -Entity xxxxxxxx-xxxx-xxxx-xxxx-1b2841850e85 -Refresh
Refresh the connection to the specified OneView appliance
-------------------------- EXAMPLE 3 --------------------------
PS C:\\>Set-OVGDAppliance -Entity xxxxxxxx-xxxx-xxxx-xxxx-1b2841850e85 -Reconnect -Username user-01
Reconnect the specified appliance with the specified user. The function will prompt for the password of the user
RELATED LINKS
https://github.com/rumart/GlobalDashboardPS
https://developer.hpe.com/blog/accessin ... hboard-api
SYNOPSIS
Perform changes to a OneView appliance
SYNTAX
Set-OVGDAppliance [-Server <Object>] -Entity <Object> [-NewName <Object>] [-WhatIf] [-Confirm] [<CommonParameters>]
Set-OVGDAppliance [-Server <Object>] -Entity <Object> [-Refresh] [-WhatIf] [-Confirm] [<CommonParameters>]
Set-OVGDAppliance [-Server <Object>] -Entity <Object> [-Reconnect] [-Username <Object>] [-Password <SecureString>]
[-LoginDomain <Object>] [-WhatIf] [-Confirm] [<CommonParameters>]
DESCRIPTION
This function can perform the following changes on a OneView appliance on the connected Global Dashboard instance:
- Change name
- Refresh the connection to the OneView appliance
- Reconnect the OneView appliance
PARAMETERS
-Server <Object>
The Global Dashboard to work with, defaults to the Global variable OVGDPSServer
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Entity <Object>
The Id of the OneView appliance to work with
Required? true
Position? named
Default value
Accept pipeline input? true (ByValue)
Accept wildcard characters? false
-NewName <Object>
Set a new name for the OneView appliance
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Refresh [<SwitchParameter>]
Refresh the connection to the specified OneView appliance
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-Reconnect [<SwitchParameter>]
Reconnect to the specified OneView appliance
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-Username <Object>
The Username of a user with access to the Global Dashboard instance
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Password <SecureString>
The Password of the specified user
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-LoginDomain <Object>
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
Required? false
Position? named
Default value
Accept pipeline input? false
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
OUTPUTS
NOTES
Info
Author : Rudi Martinsen / Intility AS
Date : 25/03-2019
Version : 0.3.1
Revised : 17/04-2019
Changelog:
0.3.1 -- Added help text
0.3.0 -- Added reconnect
0.2.0 -- Added refresh
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>Set-OVGDAppliance -Entity xxxxxxxx-xxxx-xxxx-xxxx-1b2841850e85 -NewName newname-001
Renames the specified appliance to "newname-001" on the Global Dashboard instance
-------------------------- EXAMPLE 2 --------------------------
PS C:\\>Set-OVGDAppliance -Entity xxxxxxxx-xxxx-xxxx-xxxx-1b2841850e85 -Refresh
Refresh the connection to the specified OneView appliance
-------------------------- EXAMPLE 3 --------------------------
PS C:\\>Set-OVGDAppliance -Entity xxxxxxxx-xxxx-xxxx-xxxx-1b2841850e85 -Reconnect -Username user-01
Reconnect the specified appliance with the specified user. The function will prompt for the password of the user
RELATED LINKS
https://github.com/rumart/GlobalDashboardPS
https://developer.hpe.com/blog/accessin ... hboard-api