azure.azcollection.azure_arc role – A role to Configure an Azure ARC Host.

Note

This role is part of the azure.azcollection collection (version 3.15.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it use: ansible-galaxy collection install azure.azcollection.

To use it in a playbook, specify: azure.azcollection.azure_arc.

Entry point main – A role to Configure an Azure ARC Host.

New in azure.azcollection 3.15.0

Synopsis

  • A role to Configure an Azure ARC host.

  • This role requires an resource_group, tenant id and subscription_id.

Parameters

Parameter

Comments

altdownload

string

Alternative download URL for the azcmagent package.

azure_arc_cloud

string

Which azure cloud to use.

Default: "AzureCloud"

azure_arc_location

string

Location where the Arc Host will reside.

Default will be location of azure_arc_resource_group

azure_arc_resource_group

string / required

Resource group on/from which the Arc Host will reside.

azure_arc_subscription_id

string / required

An Azure subscription id.

azure_arc_tags

dictionary

Dictionary of tags to apply to the Arc Host entry in Azure.

Default: {"ArcSQLServerExtensionDeployment": "Disabled"}

azure_arc_tenant_id

string / required

An Azure tenant id.

desired_version

string

Desired version of the azcmagent to install.

proxy

string

Define proxy if your host needs to use a proxy to get to the Internet.

hostname

string

Hostname of the proxy server.

port

string

Port that the proxy is listening on.