Add-SilVMHost

Windows Server 2016 and Windows 10

Add-SilVMHost

Adds and updates host information in the Software Inventory Logging Aggregator database.

Syntax

Parameter Set: DataCenterName
Add-SilVMHost [[-VMHostName] <String[]> ] -HostCredential <PSCredential> [-Force] [-SCVMMTargetName <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: VMHostName
Add-SilVMHost -HostCredential <PSCredential> -VMHostName <String[]> [-Force] [-HostType <String> ] [-HypervisorType <System.String> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: VMWareTarget
Add-SilVMHost [[-VMHostName] <String[]> ] -HostCredential <PSCredential> [-Force] [-VMWareTargetName <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>]




Detailed Description

The Add-SilVMHost cmdlet adds and updates host information in the Software Inventory Logging Aggregator database. This information includes fully qualified domain name (FQDN), hypervisor manufacturer, and credentials. When a host name already exists in the database, the cmdlet updates the host type and hypervisor for that host, and logs existing host names in Event Viewer.

This cmdlet can get the host information from a management server and store that information in the Software Inventory Logging Aggregator database. This cmdlet supports SCVMM and VMWare management servers.

Parameters

-Force

Forces the command to run without asking for user confirmation.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-HostCredential<PSCredential>

Specifies the credentials that allow this cmdlet to connect to the host. To obtain a PSCredential object, use the Get-Credential cmdlet. For more information, type Get-Help Get-Credential.


Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-HostType<String>

Specifies the type of the host. The acceptable values for this parameter are:

--Windows
-- VMware
-- Ubuntu
-- OpenSuse
-- Centos
-- Citrix

This cmdlet automatically detects host type, therefore, this parameter is not necessary.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-HypervisorType<System.String>

Specifies the type of the hypervisor. The acceptable values for this parameter are:

-- HyperV
-- Esxi
-- Xen
--XenServer
-- KVM

This cmdlet automatically detects hypervisor, therefore, this parameter is not necessary.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-SCVMMTargetName<String>

Specifies the name of an SCVMM management server.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-VMHostName<String[]>

Specifies an array of virtual machine host names to add or update.


Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

true(ByValue)

Accept Wildcard Characters?

false

-VMWareTargetName<String>

Specifies the name of a VMWare management or vCenter server.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Confirm

Prompts you for confirmation before running the cmdlet.


Required?

false

Position?

named

Default Value

false

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.


Required?

false

Position?

named

Default Value

false

Accept Pipeline Input?

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.

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

Outputs

The output type is the type of the objects that the cmdlet emits.

Examples

Example 1: Add host names to the database with credentials

The first command creates a credential by using the Get-Credential cmdlet. That cmdlet prompts you for user name and password. The command stores those credentials in the $Credentials variable. For more information, type Get-Help Get-Credential.

The second command identifies host type and hypervisor type. The command stores host names, host type, hypervisor type in the database. The command also updates host credentials in Credential Manager.


PS C:\> $Credential = Get-Credential
PS C:\> Add-SilVMHost -VMHostName "Host01","Host02","Host03" -HostCredential $Credential

Example 2: Get information for hosts managed by an SCVMM management server

This command gets the host information for hosts managed by an SCVMM management server. This command stores that host information in the database, and updates host credentials in Credential Manager.


PS C:\> Add-SilVMHost -HostCredential $Credential -SCVMMTargetName "ManagementServer.tsqa.contoso.com"

Example 3: Get information for hosts managed by a VMWare management server

This command gets the host information for hosts managed by a VMWare management or vCenter server. This command stores that host information in the database, and updates host credentials in Credential Manager.


PS C:\> Add-SilVMHost -HostCredential $Credential -VMWareTargetName "ManagementServer.tsqa.contoso.com"

Related topics

Community Additions

ADD
Show: