Set-iBMCService

NAME Set-iBMCService



SYNOPSIS

Modify iBMC service information, including the enablement state and port number.





SYNTAX

Set-iBMCService [-Session] <RedfishSession[]> [-ServiceName] {HTTP | HTTPS | SNMP | VirtualMedia | IPMI | SSH |

KVMIP | VNC | Video | NAT} [-Enabled] <Boolean[]> [-Port] <Int32[]> [<CommonParameters>]





DESCRIPTION

Modify iBMC service information, including the enablement state and port number.

Support Services:

"HTTP", "HTTPS", "SNMP", "VirtualMedia", "IPMI", "SSH", "KVMIP", "VNC", "Video", "NAT"





PARAMETERS

-Session <RedfishSession[]>

iBMC redfish session object which is created by Connect-iBMC cmdlet.

A session object identifies an iBMC server to which this cmdlet will be executed.



Required? true

Position? 1

Default value

Accept pipeline input? true (ByValue, ByPropertyName)

Accept wildcard characters? false



-ServiceName

Indicates the type of service to be modified.

Support value set:

"HTTP", "HTTPS", "SNMP", "VirtualMedia", "IPMI", "SSH", "KVMIP", "VNC", "Video", "NAT".



Required? true

Position? 2

Default value

Accept pipeline input? true (ByValue, ByPropertyName)

Accept wildcard characters? false



-Enabled <Boolean[]>

Indicates enabled the service or not.

Support values are powershell boolean value: $true(1), $false(0).



Required? true

Position? 3

Default value

Accept pipeline input? true (ByValue, ByPropertyName)

Accept wildcard characters? false



-Port <Int32[]>

Indicates the network port which this service listen on.

Support integer value range: [1, 65535]



Required? true

Position? 4

Default value

Accept pipeline input? true (ByValue, ByPropertyName)

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

Null

Returns Null if cmdlet executes successfully.

In case of an error or warning, exception will be returned.





-------------------------- EXAMPLE 1 --------------------------



PS C:\\>$credential = Get-Credential



PS C:\\> $session = Connect-iBMC -Address 10.1.1.2 -Credential $credential -TrustCert

PS C:\\> Set-iBMCService -Session $session -ServiceName VNC -Enabled $true -Port 5900











RELATED LINKS

https://github.com/Huawei/Huawei-iBMC-Cmdlets



Get-iBMCServices

Connect-iBMC

Disconnect-iBMC