| external help file | Module Name | online version | schema |
|---|---|---|---|
Jagabata.psm.dll-Help.xml |
Jagabata.psm |
2.0.0 |
Create a Host.
New-AnsibleHost [-Inventory] <UInt64> [-Name] <String> [-Description <String>] [-InstanceId <String>]
[-Variables <String>] [-Disabled] [-WhatIf] [-Confirm] [<CommonParameters>]
Create a Host.
Implements following Rest API:
/api/v2/hosts/(POST)
PS C:\> New-AnsibleHost -Inventory 1 -Name host_nameCreate a new Host into the Inventory of ID 1.
Optional description of the host.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseCreate a Host as disabled state.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseUsed by the remote inventory source to uniquely identify the host.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseInventory ID.
Type: UInt64
Parameter Sets: (All)
Aliases:
Required: True
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseName of the host.
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseSpecify in JSON or YAML format.
You can also specify an object of type IDictionary as a parameter value.
Example: -Variables @{ ansible_host = "192.168.0.10"; ansible_connection = "ssh"; }
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalsePrompts you for confirmation before running the cmdlet.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseShows what would happen if the cmdlet runs. The cmdlet is not run.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseThis cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
New created Host object.