< Back
Set-iBMCSNMPSetting
Post
NAME Set-iBMCSNMPSetting
SYNOPSIS
Modify iBMC SNMP Basic Settings.
SYNTAX
Set-iBMCSNMPSetting [-Session] <RedfishSession[]> [-SnmpV1Enabled <Boolean[]>] [-SnmpV2CEnabled <Boolean[]>]
[-LongPasswordEnabled <Boolean[]>] [-RWCommunityEnabled <Boolean[]>] [-ReadOnlyCommunity <Object[]>]
[-ReadWriteCommunity <Object[]>] [-SnmpV3AuthProtocol {MD5 | SHA1}] [-SnmpV3PrivProtocol {DES | AES}]
[<CommonParameters>]
DESCRIPTION
Modify iBMC SNMP Basic 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
-SnmpV1Enabled <Boolean[]>
Indicates whether SNMPV1 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
-SnmpV2CEnabled <Boolean[]>
Indicates whether SNMPV2C 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
-LongPasswordEnabled <Boolean[]>
Indicates whether long password 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
-RWCommunityEnabled <Boolean[]>
Indicates whether read-write community name 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
-ReadOnlyCommunity <Object[]>
Indicates the read only community name.
A character string that meets the following requirements:
- Cannot contain spaces.
- Contain 1 to 32 bytes by default or 16 to 32 bytes for long passwords.
- If password complexity check is enabled, the password must contain at least 8 bytes and contain at least two
types of uppercase letters, lowercase letters, digits, and special characters.
- Have at least two new characters when compared with the previous community name.
- Read-only community name and Read-write community name must be different.
Required? false
Position? named
Default value
Accept pipeline input? true (ByValue, ByPropertyName)
Accept wildcard characters? false
-ReadWriteCommunity <Object[]>
Indicates the read write community name.
A character string that meets the following requirements:
- Cannot contain spaces.
- Contain 1 to 32 bytes by default or 16 to 32 bytes for long passwords.
- If password complexity check is enabled, the password must contain at least 8 bytes and contain at least two
types of uppercase letters, lowercase letters, digits, and special characters.
- Have at least two new characters when compared with the previous community name.
- Read-only community name and Read-write community name must be different.
Required? false
Position? named
Default value
Accept pipeline input? true (ByValue, ByPropertyName)
Accept wildcard characters? false
-SnmpV3AuthProtocol
Indicates the SNMPv3 authentication algorithm.
Available Value Set: ('MD5', 'SHA')
Required? false
Position? named
Default value
Accept pipeline input? true (ByValue, ByPropertyName)
Accept wildcard characters? false
-SnmpV3PrivProtocol
Indicates the SNMPv3 encryption algorithm.
Available Value Set: ('DES', 'AES')
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:\\> $ReadOnlyCommunity = ConvertTo-SecureString -String "SomeP@ssw0rd1" -AsPlainText -Force
PS C:\\> $ReadWriteCommunity = ConvertTo-SecureString -String "SomeP@ssw0rd2" -AsPlainText -Force
PS C:\\> Set-iBMCSNMPSetting $session -SnmpV1Enabled $false -SnmpV2CEnabled $false `
-LongPasswordEnabled $true -RWCommunityEnabled $true `
-ReadOnlyCommunity $ReadOnlyCommunity -ReadWriteCommunity $ReadWriteCommunity `
-SnmpV3AuthProtocol MD5 -SnmpV3PrivProtocol DES
RELATED LINKS
https://github.com/Huawei/Huawei-iBMC-Cmdlets
Get-iBMCSNMPSetting
Get-iBMCSNMPTrapSetting
Set-iBMCSNMPTrapSetting
Get-iBMCSNMPTrapServer
Set-iBMCSNMPTrapServer
Connect-iBMC
Disconnect-iBMC
SYNOPSIS
Modify iBMC SNMP Basic Settings.
SYNTAX
Set-iBMCSNMPSetting [-Session] <RedfishSession[]> [-SnmpV1Enabled <Boolean[]>] [-SnmpV2CEnabled <Boolean[]>]
[-LongPasswordEnabled <Boolean[]>] [-RWCommunityEnabled <Boolean[]>] [-ReadOnlyCommunity <Object[]>]
[-ReadWriteCommunity <Object[]>] [-SnmpV3AuthProtocol {MD5 | SHA1}] [-SnmpV3PrivProtocol {DES | AES}]
[<CommonParameters>]
DESCRIPTION
Modify iBMC SNMP Basic 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
-SnmpV1Enabled <Boolean[]>
Indicates whether SNMPV1 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
-SnmpV2CEnabled <Boolean[]>
Indicates whether SNMPV2C 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
-LongPasswordEnabled <Boolean[]>
Indicates whether long password 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
-RWCommunityEnabled <Boolean[]>
Indicates whether read-write community name 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
-ReadOnlyCommunity <Object[]>
Indicates the read only community name.
A character string that meets the following requirements:
- Cannot contain spaces.
- Contain 1 to 32 bytes by default or 16 to 32 bytes for long passwords.
- If password complexity check is enabled, the password must contain at least 8 bytes and contain at least two
types of uppercase letters, lowercase letters, digits, and special characters.
- Have at least two new characters when compared with the previous community name.
- Read-only community name and Read-write community name must be different.
Required? false
Position? named
Default value
Accept pipeline input? true (ByValue, ByPropertyName)
Accept wildcard characters? false
-ReadWriteCommunity <Object[]>
Indicates the read write community name.
A character string that meets the following requirements:
- Cannot contain spaces.
- Contain 1 to 32 bytes by default or 16 to 32 bytes for long passwords.
- If password complexity check is enabled, the password must contain at least 8 bytes and contain at least two
types of uppercase letters, lowercase letters, digits, and special characters.
- Have at least two new characters when compared with the previous community name.
- Read-only community name and Read-write community name must be different.
Required? false
Position? named
Default value
Accept pipeline input? true (ByValue, ByPropertyName)
Accept wildcard characters? false
-SnmpV3AuthProtocol
Indicates the SNMPv3 authentication algorithm.
Available Value Set: ('MD5', 'SHA')
Required? false
Position? named
Default value
Accept pipeline input? true (ByValue, ByPropertyName)
Accept wildcard characters? false
-SnmpV3PrivProtocol
Indicates the SNMPv3 encryption algorithm.
Available Value Set: ('DES', 'AES')
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:\\> $ReadOnlyCommunity = ConvertTo-SecureString -String "SomeP@ssw0rd1" -AsPlainText -Force
PS C:\\> $ReadWriteCommunity = ConvertTo-SecureString -String "SomeP@ssw0rd2" -AsPlainText -Force
PS C:\\> Set-iBMCSNMPSetting $session -SnmpV1Enabled $false -SnmpV2CEnabled $false `
-LongPasswordEnabled $true -RWCommunityEnabled $true `
-ReadOnlyCommunity $ReadOnlyCommunity -ReadWriteCommunity $ReadWriteCommunity `
-SnmpV3AuthProtocol MD5 -SnmpV3PrivProtocol DES
RELATED LINKS
https://github.com/Huawei/Huawei-iBMC-Cmdlets
Get-iBMCSNMPSetting
Get-iBMCSNMPTrapSetting
Set-iBMCSNMPTrapSetting
Get-iBMCSNMPTrapServer
Set-iBMCSNMPTrapServer
Connect-iBMC
Disconnect-iBMC