vmware.vmware_rest.content_library_item_info module – Returns the ItemModel with the given identifier.
Note
This module is part of the vmware.vmware_rest collection (version 4.4.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 vmware.vmware_rest.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: vmware.vmware_rest.content_library_item_info.
New in vmware.vmware_rest 2.0.0
DEPRECATED
- Removed in:
version 5.0.0
- Why:
This module has been moved to the new vmware.vmware collection
- Alternative:
Use vmware.vmware.content_library_item_info instead.
Synopsis
Returns the ItemModel with the given identifier.
Requirements
The below requirements are needed on the host that executes this module.
vSphere 7.0.3 or greater
python >= 3.6
aiohttp
Parameters
Parameter |
Comments |
|---|---|
Identifier of the library whose items should be returned. The parameter must be the id of a resource returned by vmware.vmware_rest.content_library_info. Required with state=[‘list’] |
|
Identifier of the library item to return. The parameter must be the id of a resource returned by vmware.vmware_rest.content_library_item_info. Required with state=[‘get’] |
|
Timeout settings for client session. The maximal number of seconds for the whole operation including connection establishment, request sending and response. The default value is 300s. |
|
The hostname or IP address of the vSphere vCenter If the value is not specified in the task, the value of environment variable |
|
The vSphere vCenter password If the value is not specified in the task, the value of environment variable |
|
You can use this optional parameter to set the location of a log file. This file will be used to record the HTTP REST interaction. The file will be stored on the host that runs the module. If the value is not specified in the task, the value of environment variable |
|
The vSphere vCenter username If the value is not specified in the task, the value of environment variable |
|
Allows connection when SSL certificates are not valid. Set to If the value is not specified in the task, the value of environment variable Choices:
|
Notes
Note
Tested on vSphere 7.0.3
Examples
- name: Create a content library pointing on a NFS share
vmware.vmware_rest.content_locallibrary:
name: my_library_on_nfs
description: automated
publish_info:
published: true
authentication_method: NONE
storage_backings:
- storage_uri: nfs://datastore.test/srv/share/content-library
type: OTHER
state: present
register: nfs_lib
- name: Get the list of items of the NFS library
vmware.vmware_rest.content_library_item_info:
library_id: '{{ nfs_lib.id }}'
register: lib_items
- name: Get the list of items of the NFS library
vmware.vmware_rest.content_library_item_info:
library_id: '{{ nfs_lib.id }}'
register: result
- name: Create a new local content library
vmware.vmware_rest.content_locallibrary:
name: local_library_001
description: automated
publish_info:
published: true
authentication_method: NONE
storage_backings:
- datastore_id: "{{ lookup('vmware.vmware_rest.datastore_moid', '/my_dc/datastore/rw_datastore') }}"
type: DATASTORE
state: present
register: ds_lib
- name: Get the (empty) list of items of the library
vmware.vmware_rest.content_library_item_info:
library_id: '{{ ds_lib.id }}'
register: result
- name: Create subscribed library
vmware.vmware_rest.content_subscribedlibrary:
name: sub_lib
subscription_info:
subscription_url: '{{ nfs_lib.value.publish_info.publish_url }}'
authentication_method: NONE
automatic_sync_enabled: false
on_demand: true
storage_backings:
- datastore_id: "{{ lookup('vmware.vmware_rest.datastore_moid', '/my_dc/datastore/rw_datastore') }}"
type: DATASTORE
register: sub_lib
- name: Ensure the OVF is here
vmware.vmware_rest.content_library_item_info:
library_id: '{{ sub_lib.id }}'
register: result
- name: Create a content library based on a DataStore
vmware.vmware_rest.content_locallibrary:
name: my_library_on_datastore
description: automated
publish_info:
published: true
authentication_method: NONE
storage_backings:
- datastore_id: "{{ lookup('vmware.vmware_rest.datastore_moid', '/my_dc/datastore/local') }}"
type: DATASTORE
state: present
register: nfs_lib
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
Ensure the OVF is here Returned: On success Sample: |
Status
This module will be removed in version 5.0.0. [deprecated]
For more information see DEPRECATED.