Skip to content

Latest commit

 

History

History
1064 lines (821 loc) · 22.8 KB

Set-IntersightNiatelemetryNiaInventory.md

File metadata and controls

1064 lines (821 loc) · 22.8 KB
Raw
external help file Module Name online version schema
Intersight.PowerShell.dll-Help.xml
Intersight.PowerShell
2.0.0

Set-IntersightNiatelemetryNiaInventory

SYNOPSIS

Fill in the Synopsis

SYNTAX


Set-IntersightNiatelemetryNiaInventory [-AdditionalProperties< System.Collections.Generic.Dictionary`2[string,object]>][-ControllerIpAddress< string>][-Cpu< float>][-CrashResetLogs< string>][-CustomerDeviceConnector< string>][-DcnmFanDetails< System.Collections.Generic.List`1[NiatelemetryFanDetails]>][-DcnmLicenseState< string>][-DeviceDiscovery< string>][-DeviceHealth< long>][-DeviceId< string>][-DeviceName< string>][-DeviceType< string>][-DeviceUpTime< long>][-Disk< NiatelemetryDiskinfo>][-Dn< string>][-FabricName< string>][-FexCount< long>][-InfraWiNodeCount< long>][-Interface< System.Collections.Generic.List`1[NiatelemetryInterfaceElement]>][-IpAddress< string>][-IsVirtualNode< string>][-LastRebootTime< string>][-LastResetReason< string>][-LicenseState< NiatelemetryNiaLicenseStateRelationship>][-LicenseType< string>][-LogInTime< string>][-LogOutTime< string>][-MacSecCount< long>][-MacSecFabCount< long>][-MacsecTotalCount< long>][-Memory< long>][[-Moid]< string>][-NexusCloudMembershipStatus< bool>][-NodeId< string>][-NxosBgpEvpn< NiatelemetryNxosBgpEvpn>][-NxosBgpMvpn< NiatelemetryNxosBgpMvpn>][-NxosBootflashDetails< NiatelemetryBootflashDetails>][-NxosDciInterfaceStatus< string>][-NxosInterfaceBrief< NiatelemetryInterface>][-NxosNveInterfaceStatus< string>][-NxosNvePacketCounters< NiatelemetryNvePacketCounters>][-NxosNveVni< NiatelemetryNveVni>][-NxosOspfNeighbors< long>][-NxosPimNeighbors< string>][-NxosTelnet< string>][-NxosTotalRoutes< long>][-NxosVtp< NiatelemetryNxosVtp>][-RecordType< string>][-RecordVersion< string>][-RoutePrefixCount< long>][-RoutePrefixV4Count< long>][-RoutePrefixV6Count< long>][-Serial< string>][-SiteName< string>][-Siteuuid< string>][-SmartAccountId< long>][-SoftwareDownload< string>][-SystemUpTime< string>][-Tags< System.Collections.Generic.List`1[MoTag]>][-Version< string>][-VniStatus< System.Collections.Generic.List`1[NiatelemetryVniStatus]>][-VpcPeerIpAddress< string>][-Json< SwitchParameter>][-WithHttpInfo< SwitchParameter>]

DESCRIPTION

Update a 'NiatelemetryNiaInventory' resource.

PARAMETERS

-AdditionalProperties

Type: System.Collections.Generic.Dictionary`2[string,object]
Parameter Sets: (All)
Aliases:

Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: False

-ControllerIpAddress

Returns controller's IP address details.

Type: string
Parameter Sets: (All)
Aliases:

Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: False

-Cpu

CPU usage of device being inventoried. This determines the percentage of CPU resources used.

Type: float
Parameter Sets: (All)
Aliases:

Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: False

-CrashResetLogs

Last crash reset reason of device being inventoried. This determines the last reason for a device's restart due to crash of the system.

Type: string
Parameter Sets: (All)
Aliases:

Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: False

-CustomerDeviceConnector

Returns the value of the customerDeviceConnector field.

Type: string
Parameter Sets: (All)
Aliases:

Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: False

-DcnmFanDetails

Note :- Use Initialize-IntersightNiatelemetryFanDetails to create the object of complex type NiatelemetryFanDetails

Type: System.Collections.Generic.List`1[NiatelemetryFanDetails]
Parameter Sets: (All)
Aliases:

Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: False

-DcnmLicenseState

Returns the License state of the device.

Type: string
Parameter Sets: (All)
Aliases:

Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: False

-DeviceDiscovery

Returns the value of the deviceDiscovery field.

Type: string
Parameter Sets: (All)
Aliases:

Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: False

-DeviceHealth

Returns the device health.

Type: long
Parameter Sets: (All)
Aliases:

Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: False

-DeviceId

Returns the value of the deviceId field.

Type: string
Parameter Sets: (All)
Aliases:

Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: False

-DeviceName

Name of device being inventoried. The name the user assigns to the device is inventoried here.

Type: string
Parameter Sets: (All)
Aliases:

Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: False

-DeviceType

Type of device being inventoried. This determines whether the device is a controller, leaf or spine.

Type: string
Parameter Sets: (All)
Aliases:

Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: False

-DeviceUpTime

Returns the device up time.

Type: long
Parameter Sets: (All)
Aliases:

Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: False

-Disk

Disk Usage of device being inventoried. This determines the amount of disk usage.

Note :- Use Initialize-IntersightNiatelemetryDiskinfo to create the object of complex type NiatelemetryDiskinfo

Type: NiatelemetryDiskinfo
Parameter Sets: (All)
Aliases:

Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: False

-Dn

Dn for the inventories present.

Type: string
Parameter Sets: (All)
Aliases:

Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: False

-FabricName

Name of the fabric of the device being inventoried.

Type: string
Parameter Sets: (All)
Aliases:

Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: False

-FexCount

Number of fabric extendors utilized.

Type: long
Parameter Sets: (All)
Aliases:

Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: False

-InfraWiNodeCount

Number of appliances as physical device that are wired into the cluster.

Type: long
Parameter Sets: (All)
Aliases:

Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: False

-Interface

Note :- Use Initialize-IntersightNiatelemetryInterfaceElement to create the object of complex type NiatelemetryInterfaceElement

Type: System.Collections.Generic.List`1[NiatelemetryInterfaceElement]
Parameter Sets: (All)
Aliases:

Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: False

-IpAddress

The IP address of the device being inventoried.

Type: string
Parameter Sets: (All)
Aliases:

Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: False

-IsVirtualNode

Flag to specify if the node is virtual.

Type: string
Parameter Sets: (All)
Aliases:

Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: False

-LastRebootTime

Returns the last reboot Time of the device.

Type: string
Parameter Sets: (All)
Aliases:

Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: False

-LastResetReason

Returns the last reset reason of the device.

Type: string
Parameter Sets: (All)
Aliases:

Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: False

-LicenseState

A reference to a niatelemetryNiaLicenseState resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.

Note:- To get the relationship object pass the MO to the cmdlet Get-IntersightMoMoRef or use the cmdlet Initialize-IntersightMoMoRef.

Type: NiatelemetryNiaLicenseStateRelationship
Parameter Sets: (All)
Aliases:

Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: False

-LicenseType

Returns the License type of the device.

Type: string
Parameter Sets: (All)
Aliases:

Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: False

-LogInTime

Last log in time device being inventoried. This determines the last login time on the device.

Type: string
Parameter Sets: (All)
Aliases:

Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: False

-LogOutTime

Last log out time of device being inventoried. This determines the last logout time on the device.

Type: string
Parameter Sets: (All)
Aliases:

Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: False

-MacSecCount

Number of Macsec configured interfaces on a TOR.

Type: long
Parameter Sets: (All)
Aliases:

Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: False

-MacSecFabCount

Number of Macsec configured interfaces on a Spine.

Type: long
Parameter Sets: (All)
Aliases:

Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: False

-MacsecTotalCount

Number of total Macsec configured interfaces for all nodes.

Type: long
Parameter Sets: (All)
Aliases:

Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: False

-Memory

Memory usage of device being inventoried. This determines the percentage of memory resources used.

Type: long
Parameter Sets: (All)
Aliases:

Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: False

-Moid

The unique identifier of this Managed Object instance.

Type: string
Parameter Sets: (All)
Aliases:

Required: true
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: False

-NexusCloudMembershipStatus

Returns if site has been onboarded to nexus cloud or not.

Type: bool
Parameter Sets: (All)
Aliases:

Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: False

-NodeId

The ID of the device being inventoried.

Type: string
Parameter Sets: (All)
Aliases:

Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: False

-NxosBgpEvpn

Returns Nxos EVPN BGP details.

Note :- Use Initialize-IntersightNiatelemetryNxosBgpEvpn to create the object of complex type NiatelemetryNxosBgpEvpn

Type: NiatelemetryNxosBgpEvpn
Parameter Sets: (All)
Aliases:

Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: False

-NxosBgpMvpn

Returns the value of the nxosTrmConfigs field.

Note :- Use Initialize-IntersightNiatelemetryNxosBgpMvpn to create the object of complex type NiatelemetryNxosBgpMvpn

Type: NiatelemetryNxosBgpMvpn
Parameter Sets: (All)
Aliases:

Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: False

-NxosBootflashDetails

Returns the value of the nxosBootflashDetails field.

Note :- Use Initialize-IntersightNiatelemetryBootflashDetails to create the object of complex type NiatelemetryBootflashDetails

Type: NiatelemetryBootflashDetails
Parameter Sets: (All)
Aliases:

Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: False

-NxosDciInterfaceStatus

Returns the status of dci interface configured.

Type: string
Parameter Sets: (All)
Aliases:

Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: False

-NxosInterfaceBrief

Returns the value of the nxosInterfaceBrief field.

Note :- Use Initialize-IntersightNiatelemetryInterface to create the object of complex type NiatelemetryInterface

Type: NiatelemetryInterface
Parameter Sets: (All)
Aliases:

Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: False

-NxosNveInterfaceStatus

Returns the value of the nxosNveInterface field.

Type: string
Parameter Sets: (All)
Aliases:

Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: False

-NxosNvePacketCounters

Returns the value of the nxosNvePacketCounters field.

Note :- Use Initialize-IntersightNiatelemetryNvePacketCounters to create the object of complex type NiatelemetryNvePacketCounters

Type: NiatelemetryNvePacketCounters
Parameter Sets: (All)
Aliases:

Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: False

-NxosNveVni

Returns the value of the nxosNveVni field.

Note :- Use Initialize-IntersightNiatelemetryNveVni to create the object of complex type NiatelemetryNveVni

Type: NiatelemetryNveVni
Parameter Sets: (All)
Aliases:

Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: False

-NxosOspfNeighbors

Total number of ospf neighbors per switch in DCNM.

Type: long
Parameter Sets: (All)
Aliases:

Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: False

-NxosPimNeighbors

Total number of pim neighbors per switch in DCNM.

Type: string
Parameter Sets: (All)
Aliases:

Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: False

-NxosTelnet

Returns the value of the nxosTelnet field.

Type: string
Parameter Sets: (All)
Aliases:

Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: False

-NxosTotalRoutes

Total number of routes configured in the DCNM.

Type: long
Parameter Sets: (All)
Aliases:

Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: False

-NxosVtp

Returns the value of the nxosVtpStatus field.

Note :- Use Initialize-IntersightNiatelemetryNxosVtp to create the object of complex type NiatelemetryNxosVtp

Type: NiatelemetryNxosVtp
Parameter Sets: (All)
Aliases:

Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: False

-RecordType

Type of record DCNM / APIC / SE / Nexus Switch. This determines the type of platform where inventory was collected.

Type: string
Parameter Sets: (All)
Aliases:

Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: False

-RecordVersion

Version of record being pushed. This determines what was the API version for data available from the device.

Type: string
Parameter Sets: (All)
Aliases:

Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: False

-RoutePrefixCount

Total nuumber of v4 and v6 routes per node.

Type: long
Parameter Sets: (All)
Aliases:

Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: False

-RoutePrefixV4Count

Number of v4 routes per node.

Type: long
Parameter Sets: (All)
Aliases:

Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: False

-RoutePrefixV6Count

Number of v6 routes per node.

Type: long
Parameter Sets: (All)
Aliases:

Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: False

-Serial

Serial number of device being invetoried. The serial number is unique per device and will be used as the key.

Type: string
Parameter Sets: (All)
Aliases:

Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: False

-SiteName

Name of fabric domain of the controller.

Type: string
Parameter Sets: (All)
Aliases:

Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: False

-Siteuuid

Returns the uuid of the Nexus Cloud site associated to the inventory object.

Type: string
Parameter Sets: (All)
Aliases:

Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: False

-SmartAccountId

Returns the value of the smartAccountId/CustomerId field.

Type: long
Parameter Sets: (All)
Aliases:

Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: False

-SoftwareDownload

Last software downloaded of device being inventoried. This determines if software download API was used.

Type: string
Parameter Sets: (All)
Aliases:

Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: False

-SystemUpTime

The amount of time that the device being inventoried been up.

Type: string
Parameter Sets: (All)
Aliases:

Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: False

-Tags

Note :- Use Initialize-IntersightMoTag to create the object of complex type MoTag

Type: System.Collections.Generic.List`1[MoTag]
Parameter Sets: (All)
Aliases:

Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: False

-Version

Software version of device being inventoried. The various software version values for each device are available on cisco.com.

Type: string
Parameter Sets: (All)
Aliases:

Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: False

-VniStatus

Note :- Use Initialize-IntersightNiatelemetryVniStatus to create the object of complex type NiatelemetryVniStatus

Type: System.Collections.Generic.List`1[NiatelemetryVniStatus]
Parameter Sets: (All)
Aliases:

Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: False

-VpcPeerIpAddress

The TEP IP address of the node's vPC peer, if present.

Type: string
Parameter Sets: (All)
Aliases:

Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: False

-Json

Returns the json payload received in response.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: false
Position: Named
Default value: None
Accept pipeline input: True False
Accept wildcard characters: False

-WithHttpInfo

Returns the HTTP response with headers and content.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: false
Position: Named
Default value: None
Accept pipeline input: True False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

EXAMPLES

Example 1

PS C:\> Set-IntersightNiatelemetryNiaInventory

{ Add example description here }

INPUTS

System.Int32

System.String

OUTPUTS

TestModule.FavoriteStuff

NOTES

RELATED LINKS

Get-IntersightNiatelemetryNiaInventory

Initialize-IntersightMoVersionContext

Initialize-IntersightNiatelemetryBootflashDetails

Initialize-IntersightNiatelemetryDiskinfo

Initialize-IntersightNiatelemetryFanDetails

Initialize-IntersightNiatelemetryInterface

Initialize-IntersightNiatelemetryInterfaceElement

Initialize-IntersightNiatelemetryNvePacketCounters

Initialize-IntersightNiatelemetryNveVni

Initialize-IntersightNiatelemetryNxosBgpEvpn

Initialize-IntersightNiatelemetryNxosBgpMvpn

Initialize-IntersightNiatelemetryNxosVtp

Initialize-IntersightNiatelemetryVniStatus