community.general.nexmo module – Send a SMS via nexmo
Note
This module is part of the community.general collection (version 5.8.3).
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 community.general
.
To use it in a playbook, specify: community.general.nexmo
.
Synopsis
Send a SMS message via nexmo
Parameters
Parameter |
Comments |
---|---|
Nexmo API Key |
|
Nexmo API Secret |
|
PEM formatted certificate chain file to be used for SSL client authentication. This file can also include the key as well, and if the key is included, |
|
PEM formatted file that contains your private key to be used for SSL client authentication. If |
|
Phone number(s) to send SMS message to |
|
If Choices:
|
|
Credentials specified with url_username and url_password should be passed in HTTP Header. Choices:
|
|
Header to identify as, generally appears in web server logs. Default: |
|
Message to text to send. Messages longer than 160 characters will be split into multiple messages |
|
Nexmo Number to send from |
|
HTTP, HTTPS, or FTP URL in the form (http|https|ftp)://[user[:pass]]@host.domain[:port]/path |
|
The password for use in HTTP basic authentication. If the url_username parameter is not specified, the url_password parameter will not be used. |
|
The username for use in HTTP basic authentication. This parameter can be used without url_password for sites that allow empty passwords |
|
Use GSSAPI to perform the authentication, typically this is for Kerberos or Kerberos through Negotiate authentication. Requires the Python library gssapi to be installed. Credentials for GSSAPI can be specified with url_username/url_password or with the GSSAPI env var NTLM authentication is Choices:
|
|
If Choices:
|
|
If Choices:
|
Examples
- name: Send notification message via Nexmo
community.general.nexmo:
api_key: 640c8a53
api_secret: 0ce239a6
src: 12345678901
dest:
- 10987654321
- 16789012345
msg: '{{ inventory_hostname }} completed'
delegate_to: localhost
Collection links
Issue Tracker Repository (Sources) Submit a bug report Request a feature Communication