Invoke-VMHostProfile

This cmdlet applies a host profile to the specified host or cluster. The host or cluster must be in a maintenance mode. If no value is provided to the Profile parameter, the profile currently associated with the host or cluster is applied.

Syntax

-Entity  <InventoryItem[]>
[-ApplyOnly]
[-AssociateOnly]
[-Profile  <VMHostProfile>]
[-RunAsync]
[-Server  <VIServer[]>]
[-Variable  <Hashtable>]
[CommonParameters]

Parameters

Required Parameter Name Type Position Features Description
required
Entity
InventoryItem[] named
  • wildcards
  • pipeline
  • Specifies hosts or clusters to which you want to apply the virtual machine host profile.
    optional
    ApplyOnly
    SwitchParameter named Indicates whether to apply the host profile to the specified virtual machine host without associating it.
    optional
    AssociateOnly
    SwitchParameter named Indicates whether to associate the host profile to the specified host or cluster without applying it.
    optional
    Profile
    VMHostProfile named
  • wildcards
  • pipeline
  • Specifies the host profile you want to apply.
    optional
    RunAsync
    SwitchParameter named Indicates that the command returns immediately without waiting for the task to complete. In this mode, the output of the cmdlet is a Task object. For more information about the RunAsync parameter run "help About_RunAsync" in the VMware PowerCLI console.
    optional
    Server
    VIServer[] named
  • wildcards
  • Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.
    optional
    Variable
    Hashtable named
  • pipeline
  • Specifies a hash table object that provides values for the host profile required variables.

    Output

    VMware.VimAutomation.ViCore.Types.V1.Inventory.VMHost

    Examples


    Example 1

    Invoke-VMHostProfile -AssociateOnly -Entity $cluster -Profile $profile

    Associates the specified profile to all hosts in the specified cluster.

    Example 2

    Invoke-VMHostProfile -Entity $vmhost -Profile $profile

    Associates and applies the specified profile to the specified host.

    Example 3

    Get-VMHost | Invoke-VMHostProfile -ApplyOnly -Profile $profile

    Applies the specified profile to all specified hosts.

    Example 4

    Get-VMHost | Invoke-VMHostProfile -AssociateOnly -profile $profile

    Associates the specified profile to all specified hosts.

    Example 5

    Invoke-VMHostProfile $vmhost

    Applies the associated host's profile to the host.

    Example 6

    $requireInput = Invoke-VMHostProfile $vmhost -Profile $profile;
    $requireInput['network.hostPortGroup["key-vim-profile-host-HostPortgroupProfile-VMkernel"].ipConfig.IpAddressPolicy.address'] = '192.168.0.1';
    $requireInput['network.hostPortGroup["key-vim-profile-host-HostPortgroupProfile-VMkernel"].ipConfig.IpAddressPolicy.subnetmask'] = '255.255.255.0';
    Invoke-VMHostProfile $vmhost -Profile $profile -Variable $requireInput;

    Applies a profile to host but first assigns values to all required values.

    Related Commands

    Feedback

    Was this page helpful?