tremble.signalfx.session_module.rst

tremble.signalfx.session

log into the SignalFX API

Version added: 0.1.0

• Synopsis
• Parameters
• Examples
• Return Values
• Status

Synopsis

• Logs into the SignalFX API and generates a session token.

Parameters

Parameter	Choices/Defaults	Comments
email string / required		The email address of the user.
password string / required		The password of the user
realm string	Default: "us0"	The SignalFX realm to use.

Examples

# Login using an email/password
- session:
    realm: us1
    email: somebody@example.com
    password: Not-A-Real-Password

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Returned	Description
token string	On success	A SignalFX Session token.

Status

Authors

• Mark Chappell (@tremble)