fortiflexvm_entitlements_vm_create - Create one or more VMs based on a FortiFlex Configuration.
Added in version 2.0.0.
Synopsis
Create one or more VMs based on a FortiFlex Configuration. This API is only used to create one or more VMs. To modify a VM, please refer to fortiflexvm_entitlements_update.
Requirements
The below requirements are needed on the host that executes this module.
ansible>=2.15
Parameters
- username The username to authenticate. If not declared, the code will read the environment variable FORTIFLEX_ACCESS_USERNAME.type: str
- password The password to authenticate. If not declared, the code will read the environment variable FORTIFLEX_ACCESS_PASSWORD.type: str
- configId The ID of a FortiFlex Configuration.type: intrequired: True
- count The number of VM(s) to be created. The default value is 1.type: intdefault: 1
- description The description of VM(s).type: strdefault: ""
- endDate VM(s) end date. It can not be before today's date or after the program's end date. Any format that satisfies [ISO 8601](https://www.w3.org/TR/NOTE-datetime-970915.html) is accepted. Recommended format is "YYYY-MM-DDThh:mm:ss". If not specify, it will use the program's end date automatically.type: str
- folderPath The folder path of the VM(s).type: str
- skipPending Set it to true will activate the entitlement right away and charges start to incur even without downloading the license by token.type: bool
Examples
- name: Create VMs.
hosts: localhost
vars:
username: "<your_own_value>"
password: "<your_own_value>"
tasks:
- name: Create Virtual Machines.
fortinet.fortiflexvm.fortiflexvm_entitlements_vm_create:
username: "{{ username }}"
password: "{{ password }}"
configId: 42
count: 1 # If you set it as 0, FortiFlexvm ansible collection will not create any vm.
# description: "Create through Ansible" # Optional.
# endDate: "2023-11-11T00:00:00" # Optional. If not set, it will use the program end date automatically.
# folderPath: "My Assets" # Optional. If not set, new VM will be in "My Assets"
# skipPending: false # Optional. Set 'skipPending' to true will activate the entitlement right away and charges start.
register: result
- name: Display response
ansible.builtin.debug:
var: result.entitlements
Return Values
- entitlements A list of virtual machine entitlements and their details.type: listreturned: always
- accountId The ID of the account associated with the program.type: intreturned: always
- configId The ID of the virtual machine configuration.type: intreturned: always
- description The description of the virtual machine.type: strreturned: always
- endDate The end date of the virtual machine's validity.type: strreturned: always
- serialNumber The serial number of the virtual machine.type: strreturned: always
- startDate The start date of the virtual machine's validity.type: strreturned: always
- status The status of the virtual machine.type: strreturned: always
- token The token assigned to the virtual machine.type: strreturned: always
- tokenStatus The status of the token assigned to the virtual machine.type: strreturned: always