community.general.nexmo – Send a SMS via nexmo
community.general.nexmo – Send a SMS via nexmo
Note
This plugin is part of the community.general collection (version 2.0.1).
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 | Choices/Defaults | Comments |
---|---|---|
api_key string / required |
Nexmo API Key | |
api_secret string / required |
Nexmo API Secret | |
client_cert path |
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, | |
client_key path |
PEM formatted file that contains your private key to be used for SSL client authentication. If | |
dest list / elements=string / required |
Phone number(s) to send SMS message to | |
force boolean |
|
If Alias
|
force_basic_auth boolean |
|
Credentials specified with url_username and url_password should be passed in HTTP Header. |
http_agent string |
Default: "ansible-httpget" |
Header to identify as, generally appears in web server logs. |
msg string / required |
Message to text to send. Messages longer than 160 characters will be split into multiple messages | |
src integer / required |
Nexmo Number to send from | |
url string |
HTTP, HTTPS, or FTP URL in the form (http|https|ftp)://[user[:pass]]@host.domain[:port]/path | |
url_password string |
The password for use in HTTP basic authentication. If the url_username parameter is not specified, the url_password parameter will not be used. | |
url_username string |
The username for use in HTTP basic authentication. This parameter can be used without url_password for sites that allow empty passwords | |
use_gssapi boolean added in 2.11 of ansible.builtin |
|
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 |
use_proxy boolean |
|
If |
validate_certs boolean |
|
If |
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
Authors
- Matt Martz (@sivel)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/general/nexmo_module.html