azure_rm_virtualmachine_scaleset_facts - Get Virtual Machine Scale Set facts¶
New in version 2.4.
Synopsis¶
- Get facts for a virtual machine scale set
Requirements¶
The below requirements are needed on the host that executes this module.
- python >= 2.7
- azure >= 2.0.0
Parameters¶
| Parameter | Choices/Defaults | Comments |
|---|---|---|
| ad_user |
Active Directory username. Use when authenticating with an Active Directory user rather than service principal.
|
|
|
adfs_authority_url
(added in 2.6) |
Default: None
|
Azure AD authority url. Use when authenticating with Username/password, and has your own ADFS authority.
|
|
api_profile
(added in 2.5) |
Default: latest
|
Selects an API profile to use when communicating with Azure services. Default value of
latest is appropriate for public clouds; future values will allow use with Azure Stack. |
|
auth_source
(added in 2.5) |
|
Controls the source of the credentials to use for authentication.
If not specified, ANSIBLE_AZURE_AUTH_SOURCE environment variable will be used and default to
auto if variable is not defined.auto will follow the default precedence of module parameters -> environment variables -> default profile in credential file ~/.azure/credentials.When set to
cli, the credentials will be sources from the default Azure CLI profile.Can also be set via the
ANSIBLE_AZURE_AUTH_SOURCE environment variable.When set to
msi, the host machine must be an azure resource with an enabled MSI extension. subscription_id or the environment variable AZURE_SUBSCRIPTION_ID can be used to identify the subscription ID if the resource is granted access to more than one subscription, otherwise the first subscription is chosen.The
msi was added in Ansible 2.6. |
|
cert_validation_mode
(added in 2.5) |
|
Controls the certificate validation behavior for Azure endpoints. By default, all modules will validate the server certificate, but when an HTTPS proxy is in use, or against Azure Stack, it may be necessary to disable this behavior by passing
ignore. Can also be set via credential file profile or the AZURE_CERT_VALIDATION environment variable. |
| client_id |
Azure client ID. Use when authenticating with a Service Principal.
|
|
|
cloud_environment
(added in 2.4) |
Default: AzureCloud
|
For cloud environments other than the US public cloud, the environment name (as defined by Azure Python SDK, eg,
AzureChinaCloud, AzureUSGovernment), or a metadata discovery endpoint URL (required for Azure Stack). Can also be set via credential file profile or the AZURE_CLOUD_ENVIRONMENT environment variable. |
|
format
(added in 2.6) |
|
Format of the data returned.
If
raw is selected information will be returned in raw format from Azure Python SDK.If
curated is selected the structure will be identical to input parameters of azure_rm_virtualmachine_scaleset module.In Ansible 2.5 and lower facts are always returned in raw format.
Please note that this option will be deprecated in 2.10 when curated format will become the only supported format.
|
| name |
Limit results to a specific virtual machine scale set
|
|
| password |
Active Directory user password. Use when authenticating with an Active Directory user rather than service principal.
|
|
| profile |
Security profile found in ~/.azure/credentials file.
|
|
| resource_group |
The resource group to search for the desired virtual machine scale set
|
|
| secret |
Azure client secret. Use when authenticating with a Service Principal.
|
|
| subscription_id |
Your Azure subscription Id.
|
|
| tags |
List of tags to be matched
|
|
| tenant |
Azure tenant ID. Use when authenticating with a Service Principal.
|
Notes¶
Note
- For authentication with Azure you can pass parameters, set environment variables or use a profile stored in ~/.azure/credentials. Authentication is possible using a service principal or Active Directory user. To authenticate via service principal, pass subscription_id, client_id, secret and tenant or set environment variables AZURE_SUBSCRIPTION_ID, AZURE_CLIENT_ID, AZURE_SECRET and AZURE_TENANT.
- To authenticate via Active Directory user, pass ad_user and password, or set AZURE_AD_USER and AZURE_PASSWORD in the environment.
- Alternatively, credentials can be stored in ~/.azure/credentials. This is an ini file containing a [default] section and the following keys: subscription_id, client_id, secret and tenant or subscription_id, ad_user and password. It is also possible to add additional profiles. Specify the profile by passing profile or setting AZURE_PROFILE in the environment.
Examples¶
- name: Get facts for a virtual machine scale set
azure_rm_virtualmachine_scaleset_facts:
resource_group: Testing
name: testvmss001
format: curated
- name: Get facts for all virtual networks
azure_rm_virtualmachine_scaleset_facts:
resource_group: Testing
- name: Get facts by tags
azure_rm_virtualmachine_scaleset_facts:
resource_group: Testing
tags:
- testing
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
| Key | Returned | Description | ||
|---|---|---|---|---|
|
vmss
complex
|
always |
List of virtual machine scale sets
|
||
|
load_balancer
str
|
always |
Load balancer name.
Sample:
testlb
|
||
|
resource_group
str
|
always |
Resource group.
Sample:
testrg
|
||
|
virtual_network_name
str
|
always |
Associated virtual network name.
Sample:
testvn
|
||
|
image
complex
|
always |
Image specification
|
||
|
sku
str
|
SKU name.
Sample:
7-RAW
|
|||
|
publisher
str
|
Publisher name.
Sample:
RedHat
|
|||
|
version
str
|
Image version.
Sample:
7.5.2018050901
|
|||
|
offer
str
|
Offer.
Sample:
RHEL
|
|||
|
upgrade_policy
str
|
always |
Upgrade policy.
Sample:
Manual
|
||
|
managed_disk_type
str
|
always |
Managed data disk type
Sample:
Standard_LRS
|
||
|
tier
str
|
always |
SKU Tier.
Sample:
Basic
|
||
|
vm_size
str
|
always |
Virtual machine size.
Sample:
Standard_D4
|
||
|
ssh_password_enabled
bool
|
always |
Is SSH password authentication enabled. Valid only for Linux.
Sample:
True
|
||
|
capacity
int
|
always |
Capacity of VMSS.
Sample:
2
|
||
|
name
str
|
always |
Resource name.
Sample:
myvmss
|
||
|
admin_username
str
|
always |
Admin username used to access the host after it is created.
Sample:
adminuser
|
||
|
subnet_name
str
|
always |
Subnet name.
Sample:
testsubnet
|
||
|
location
str
|
always |
Resource location.
Sample:
japaneast
|
||
|
os_type
str
|
always |
Base type of operating system.
Sample:
Linux
|
||
|
data_disks
complex
|
always |
List of attached data disks.
|
||
|
caching
str
|
Type of data disk caching.
Sample:
ReadOnly
|
|||
|
managed_disk_type
str
|
Managed data disk type
Sample:
Standard_LRS
|
|||
|
disk_size_gb
int
|
The initial disk size in GB for blank data disks
Sample:
64
|
|||
|
lun
int
|
The logical unit number for data disk
|
|||
|
os_disk_caching
str
|
always |
Type of OS disk caching.
Sample:
ReadOnly
|
||
Status¶
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
Maintenance¶
This module is flagged as community which means that it is maintained by the Ansible Community. See Module Maintenance & Support for more info.
For a list of other modules that are also maintained by the Ansible Community, see here.
Author¶
- Sertac Ozercan (@sozercan)
Hint
If you notice any issues in this documentation you can edit this document to improve it.