# request for comments: Ansible reference card **URL:** \ **Category:** Ansible Project\ **Created:** [September 4, 2012, 8:18am UTC](https://forum.ansible.com/t/request-for-comments-ansible-reference-card/11859 "2012-09-04T08:18:48Z")\ **Posts on this page:** 4\ **Page:** 1
**Author:** ![jpmens1](https://avatars.discourse-cdn.com/v4/letter/j/e9c0ed/32.png) [@jpmens1](https://forum.ansible.com/u/jpmens1)\ **Post date:** [September 4, 2012, 8:18am UTC](https://forum.ansible.com/t/request-for-comments-ansible-reference-card/11859/1 "2012-09-04T08:18:48Z")
Hello, Please find attached a DRAFT INITIAL FIRST VERYBASIC /dev/null-VERSION (!!) for an Ansible reference card. As usual, this kind of an idea turns out to be more work than anticipated... The idea is to create a desktop reference for Ansible, and \*not\* to replace the project's documentation! I'd like a few pages on which I can be reminded of how templates work, SSH connections are done, module parameters, tips & tricks, etc. A lot (most) of this is currently copied/pasted from Ansible's documentation. I'd \*very greatly\* appreciate your feedback. I'd particularly appreciate snippets of plain text I can add to some of the sections. (Plain text is fine -- I'll do the rest.) If you have some bright ideas on how to best fill the missing sections or how to improve on existing sections, please speak up: the project will have an AUTHORS file which is just waiting for your name... πŸ™‚ Give me tips and tricks. Write a short paragraph on how to best set up Paramiko and native SSH. P.l.e.a.s.e. πŸ™‚ 1. Don't mind the green bits: they're temporary to ensure I'm using    correct markup πŸ™‚ 2. Red bits are clickable 3. I'm writing this in LaTeX so we'll be able to share this on Github,    etc. 4. I've forseen a "short" version of the reference card which omits some    of the verbosity in the Modules section, thereby reducing the page    count. Regards,         -JP PS: kindly burn PDF after reading. > **(attachments)** > > [ansible-refcard.pdf](https://forum.ansible.com/uploads/short-url/sA4dlozH8fD5zKfEDnXIwoxyOM2.pdf) (209 KB) ---
**Author:** ![Tim\_Bielawa](https://avatars.discourse-cdn.com/v4/letter/t/ed8c4c/32.png) [@Tim\_Bielawa](https://forum.ansible.com/u/Tim_Bielawa)\ **Post date:** [September 4, 2012, 5:53pm UTC](https://forum.ansible.com/t/request-for-comments-ansible-reference-card/11859/2 "2012-09-04T17:53:29Z")
I take it that filled dots are required and open dots are optional? Is this short enough for the nagios module? Perform common tasks in Nagios related to downtime and notifications. This command should 'delegate\_to:' your nagios server. Options for all actions: (\*) action - downtime, enable\_alerts, disable\_alerts, silence, unsilence (\*) host - host to operate on (ex: $inventory\_hostname) Important downtime options: ( ) minutes - minutes to schedule downtime for (default=30) (\*) services - services to manage downtime/alerts for Important enable/disable\_alerts options: (\*) services - services to manage downtime/alerts for The silence and unsilence actions have no additional options. Separate multiple services with commas. See \ for commented examples. \* Note: I'm submitting a PR presently for the the online docs to mark 'services' as required. ---
**Author:** ![Tim\_Bielawa](https://avatars.discourse-cdn.com/v4/letter/t/ed8c4c/32.png) [@Tim\_Bielawa](https://forum.ansible.com/u/Tim_Bielawa)\ **Post date:** [September 4, 2012, 6:23pm UTC](https://forum.ansible.com/t/request-for-comments-ansible-reference-card/11859/3 "2012-09-04T18:23:30Z")
> Hello, > > Please find attached a DRAFT INITIAL FIRST VERYBASIC /dev/null-VERSION > (!!) for an Ansible reference card. As usual, this kind of an idea turns > out to be more work than anticipated... > > The idea is to create a desktop reference for Ansible, and \*not\* to > replace the project's documentation! I'd like a few pages on which I can > be reminded of how templates work, SSH connections are done, module > parameters, tips & tricks, etc. > > A lot (most) of this is currently copied/pasted from Ansible's > documentation. > > I'd \*very greatly\* appreciate your feedback. I'd particularly appreciate > snippets of plain text I can add to some of the sections. (Plain text is > fine -- I'll do the rest.) If you have some bright ideas on how to best > fill the missing sections or how to improve on existing sections, please > speak up: the project will have an AUTHORS file which is just waiting > for your name... πŸ™‚ > > Give me tips and tricks. Write a short paragraph on how to best set up > Paramiko and native SSH. P.l.e.a.s.e. πŸ™‚ Paramiko is a native python implementation of the SSH protocol. It's the default transport method used by Ansible, this method should work for 99% of people by default. The native ssh transport method is necessary in more complicated infrastructures where support for bastion ('proxy') hosts is necessary, or if GSSAPI (kerberos) is used for authentication. The native ssh transport will recognize your ~/.ssh/config file because it uses the 'ssh' command installed on the local system. > 1. Don't mind the green bits: they're temporary to ensure I'm using >    correct markup πŸ™‚ > 2. Red bits are clickable > 3. I'm writing this in LaTeX so we'll be able to share this on Github, >    etc. > 4. I've forseen a "short" version of the reference card which omits some >    of the verbosity in the Modules section, thereby reducing the page >    count. > > Regards, > >         -JP > > PS: kindly burn PDF after reading. PR submitted to fix the online nagios docs, wtr 'services' = required. This is pretty nicely formatted. Also, I see now where you mention full/empty circles. The part about environment variables is kind of legacy behavior. My understanding is that even though some ENV vars work, they're not fully supported as a configuration method. You might want to stick to just mentioning $ANSIBLE\_CONFIG and giving reference to [http://ansible.github.com/examples.html#configuration-defaults](http://ansible.github.com/examples.html#configuration-defaults) ---
**Author:** ![jpmens1](https://avatars.discourse-cdn.com/v4/letter/j/e9c0ed/32.png) [@jpmens1](https://forum.ansible.com/u/jpmens1)\ **Post date:** [September 5, 2012, 5:15am UTC](https://forum.ansible.com/t/request-for-comments-ansible-reference-card/11859/4 "2012-09-05T05:15:11Z")
Tim, > Paramiko is .... thanks! Keep 'em coming! πŸ˜‰ You're also welcome to send directly to me if you prefer.         -JP