< Back
Set-iBMCNTPSetting
Post
NAME Set-iBMCNTPSetting
SYNOPSIS
Modify iBMC NTP Settings.
SYNTAX
Set-iBMCNTPSetting [-Session] <RedfishSession[]> [-ServiceEnabled <Boolean[]>] [-PreferredNtpServer <String[]>]
[-AlternateNtpServer <String[]>] [-NtpAddressOrigin {IPv4 | IPv6 | Static}] [-MinPollingInterval <Int32[]>]
[-MaxPollingInterval <Int32[]>] [-ServerAuthenticationEnabled <Boolean[]>] [<CommonParameters>]
DESCRIPTION
Modify iBMC NTP Settings.
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
-ServiceEnabled <Boolean[]>
Indicates whether NTP is enabled.
Support values are powershell boolean value: $true(1), $false(0).
Required? false
Position? named
Default value
Accept pipeline input? true (ByValue, ByPropertyName)
Accept wildcard characters? false
-PreferredNtpServer <String[]>
Indicates the address of the preferred NTP server.
A character string that meets the following requirements:
- IPv4, IPv6 address or domain name
- Contains 1 to 67 characters
Required? false
Position? named
Default value
Accept pipeline input? true (ByValue, ByPropertyName)
Accept wildcard characters? false
-AlternateNtpServer <String[]>
Indicates the address of the alternate NTP server.
A character string that meets the following requirements:
- IPv4, IPv6 address or domain name
- Contains 1 to 67 characters
Required? false
Position? named
Default value
Accept pipeline input? true (ByValue, ByPropertyName)
Accept wildcard characters? false
-NtpAddressOrigin
Indicates the NTP Address mode.
Available Value Set: IPV4, IPV6, Static
Required? false
Position? named
Default value
Accept pipeline input? true (ByValue, ByPropertyName)
Accept wildcard characters? false
-MinPollingInterval <Int32[]>
Minimum NTP polling interval.
It can be a value from 3 to 17. The value cannot be greater than MaxPollingInterval.
Required? false
Position? named
Default value
Accept pipeline input? true (ByValue, ByPropertyName)
Accept wildcard characters? false
-MaxPollingInterval <Int32[]>
Maximum NTP polling interval.
It can be a value from 3 to 17. The value cannot be less than MinPollingInterval.
Required? false
Position? named
Default value
Accept pipeline input? true (ByValue, ByPropertyName)
Accept wildcard characters? false
-ServerAuthenticationEnabled <Boolean[]>
Indicates Whether server authentication is enabled.
Support values are powershell boolean value: $true(1), $false(0).
Required? false
Position? named
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-iBMCNTPSetting $session -ServiceEnabled $true
-PreferredNtpServer 'pre.huawei.com' -AlternateNtpServer 'alt.huawei.com' `
-NtpAddressOrigin Static -ServerAuthenticationEnabled $false `
-MinPollingInterval 10 -MaxPollingInterval 12
RELATED LINKS
https://github.com/Huawei/Huawei-iBMC-Cmdlets
Get-iBMCNTPSetting
Import-iBMCNTPKey
Connect-iBMC
Disconnect-iBMC
SYNOPSIS
Modify iBMC NTP Settings.
SYNTAX
Set-iBMCNTPSetting [-Session] <RedfishSession[]> [-ServiceEnabled <Boolean[]>] [-PreferredNtpServer <String[]>]
[-AlternateNtpServer <String[]>] [-NtpAddressOrigin {IPv4 | IPv6 | Static}] [-MinPollingInterval <Int32[]>]
[-MaxPollingInterval <Int32[]>] [-ServerAuthenticationEnabled <Boolean[]>] [<CommonParameters>]
DESCRIPTION
Modify iBMC NTP Settings.
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
-ServiceEnabled <Boolean[]>
Indicates whether NTP is enabled.
Support values are powershell boolean value: $true(1), $false(0).
Required? false
Position? named
Default value
Accept pipeline input? true (ByValue, ByPropertyName)
Accept wildcard characters? false
-PreferredNtpServer <String[]>
Indicates the address of the preferred NTP server.
A character string that meets the following requirements:
- IPv4, IPv6 address or domain name
- Contains 1 to 67 characters
Required? false
Position? named
Default value
Accept pipeline input? true (ByValue, ByPropertyName)
Accept wildcard characters? false
-AlternateNtpServer <String[]>
Indicates the address of the alternate NTP server.
A character string that meets the following requirements:
- IPv4, IPv6 address or domain name
- Contains 1 to 67 characters
Required? false
Position? named
Default value
Accept pipeline input? true (ByValue, ByPropertyName)
Accept wildcard characters? false
-NtpAddressOrigin
Indicates the NTP Address mode.
Available Value Set: IPV4, IPV6, Static
Required? false
Position? named
Default value
Accept pipeline input? true (ByValue, ByPropertyName)
Accept wildcard characters? false
-MinPollingInterval <Int32[]>
Minimum NTP polling interval.
It can be a value from 3 to 17. The value cannot be greater than MaxPollingInterval.
Required? false
Position? named
Default value
Accept pipeline input? true (ByValue, ByPropertyName)
Accept wildcard characters? false
-MaxPollingInterval <Int32[]>
Maximum NTP polling interval.
It can be a value from 3 to 17. The value cannot be less than MinPollingInterval.
Required? false
Position? named
Default value
Accept pipeline input? true (ByValue, ByPropertyName)
Accept wildcard characters? false
-ServerAuthenticationEnabled <Boolean[]>
Indicates Whether server authentication is enabled.
Support values are powershell boolean value: $true(1), $false(0).
Required? false
Position? named
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-iBMCNTPSetting $session -ServiceEnabled $true
-PreferredNtpServer 'pre.huawei.com' -AlternateNtpServer 'alt.huawei.com' `
-NtpAddressOrigin Static -ServerAuthenticationEnabled $false `
-MinPollingInterval 10 -MaxPollingInterval 12
RELATED LINKS
https://github.com/Huawei/Huawei-iBMC-Cmdlets
Get-iBMCNTPSetting
Import-iBMCNTPKey
Connect-iBMC
Disconnect-iBMC