< Back
Set-vRNIDataSourceSNMPConfig
Post
NAME Set-vRNIDataSourceSNMPConfig
SYNOPSIS
Updates the SNMP configuration of a switch or UCS datasource within vRealize Network Insight
SYNTAX
Set-vRNIDataSourceSNMPConfig [-DataSource] <PSObject> [-Enabled <Boolean>] [-Connection <PSObject>]
[<CommonParameters>]
Set-vRNIDataSourceSNMPConfig [-DataSource] <PSObject> [-Enabled <Boolean>] -Community <String> [-Connection
<PSObject>] [<CommonParameters>]
Set-vRNIDataSourceSNMPConfig [-DataSource] <PSObject> [-Enabled <Boolean>] -Username <String> -ContextName
<String> -AuthenticationType <String> -AuthenticationPassword <String> -PrivacyType <String> -PrivacyPassword
<String> [-Connection <PSObject>] [<CommonParameters>]
DESCRIPTION
Physical devices like switches and UCS systems have SNMP options, which vRNI can
read out to provide interface bandwidth graphs. This cmdlet allows you to set
the SNMP configuration of a specific data source.
PARAMETERS
-DataSource <PSObject>
Datasource object, gotten from Get-vRNIDataSource
Required? true
Position? 2
Default value
Accept pipeline input? true (ByValue)
Accept wildcard characters? false
-Enabled <Boolean>
Enable SNMP?
Required? false
Position? named
Default value True
Accept pipeline input? false
Accept wildcard characters? false
-Community <String>
This param is only required when configuring SNMP v2c
SNMP v2c Community string
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Username <String>
These params are only required when configuring SNMP v3
SNMP v3 Username
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-ContextName <String>
SNMP v3 Context name
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-AuthenticationType <String>
SNMP v3 Context name
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-AuthenticationPassword <String>
SNMP v3 Authentication Password
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-PrivacyType <String>
SNMP v3 Privacy Type
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-PrivacyPassword <String>
SNMP v3 Privacy Password
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Connection <PSObject>
vRNI Connection object
Required? false
Position? named
Default value $defaultvRNIConnection
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
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>$snmpOptions = @{ "Enabled" = $true; "Username" = "snmpv3user"; "ContextName" = " "; "AuthenticationType" =
"MD5"; "AuthenticationPassword" = "ult1m4t3p4ss"; "PrivacyType" = "AES128"; "PrivacyPassword" = "s0pr1v4t3"; }
PS C:\\> Get-vRNIDataSource | Where {$_.nickname -eq "Core01"} | Set-vRNIDataSourceSNMPConfig @snmpOptions
Configures SNMPv3 for a data source named 'Core01'
-------------------------- EXAMPLE 2 --------------------------
PS C:\\>Get-vRNIDataSource -DataSourceType ciscoswitch | Set-vRNIDataSourceSNMPConfig -Enabled $true -Community
"qwerty1234"
Configured SNMPv2 on all Cisco switch datasources.
RELATED LINKS
SYNOPSIS
Updates the SNMP configuration of a switch or UCS datasource within vRealize Network Insight
SYNTAX
Set-vRNIDataSourceSNMPConfig [-DataSource] <PSObject> [-Enabled <Boolean>] [-Connection <PSObject>]
[<CommonParameters>]
Set-vRNIDataSourceSNMPConfig [-DataSource] <PSObject> [-Enabled <Boolean>] -Community <String> [-Connection
<PSObject>] [<CommonParameters>]
Set-vRNIDataSourceSNMPConfig [-DataSource] <PSObject> [-Enabled <Boolean>] -Username <String> -ContextName
<String> -AuthenticationType <String> -AuthenticationPassword <String> -PrivacyType <String> -PrivacyPassword
<String> [-Connection <PSObject>] [<CommonParameters>]
DESCRIPTION
Physical devices like switches and UCS systems have SNMP options, which vRNI can
read out to provide interface bandwidth graphs. This cmdlet allows you to set
the SNMP configuration of a specific data source.
PARAMETERS
-DataSource <PSObject>
Datasource object, gotten from Get-vRNIDataSource
Required? true
Position? 2
Default value
Accept pipeline input? true (ByValue)
Accept wildcard characters? false
-Enabled <Boolean>
Enable SNMP?
Required? false
Position? named
Default value True
Accept pipeline input? false
Accept wildcard characters? false
-Community <String>
This param is only required when configuring SNMP v2c
SNMP v2c Community string
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Username <String>
These params are only required when configuring SNMP v3
SNMP v3 Username
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-ContextName <String>
SNMP v3 Context name
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-AuthenticationType <String>
SNMP v3 Context name
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-AuthenticationPassword <String>
SNMP v3 Authentication Password
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-PrivacyType <String>
SNMP v3 Privacy Type
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-PrivacyPassword <String>
SNMP v3 Privacy Password
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Connection <PSObject>
vRNI Connection object
Required? false
Position? named
Default value $defaultvRNIConnection
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
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>$snmpOptions = @{ "Enabled" = $true; "Username" = "snmpv3user"; "ContextName" = " "; "AuthenticationType" =
"MD5"; "AuthenticationPassword" = "ult1m4t3p4ss"; "PrivacyType" = "AES128"; "PrivacyPassword" = "s0pr1v4t3"; }
PS C:\\> Get-vRNIDataSource | Where {$_.nickname -eq "Core01"} | Set-vRNIDataSourceSNMPConfig @snmpOptions
Configures SNMPv3 for a data source named 'Core01'
-------------------------- EXAMPLE 2 --------------------------
PS C:\\>Get-vRNIDataSource -DataSourceType ciscoswitch | Set-vRNIDataSourceSNMPConfig -Enabled $true -Community
"qwerty1234"
Configured SNMPv2 on all Cisco switch datasources.
RELATED LINKS