spiro-ip
========
A quick and simple module to get information about the various IPs of your salt
minions.
This is meant to be installed on minions.
Installation
============
On minions, run `pip install spiro-ip`
Or, as a state:
```
{% if grains['pythonversion'][0] == 2 %}
{% set pipbin = "/usr/bin/pip2" %}
{% else %}
{% set pipbin = "/usr/bin/pip3" %}
{% endif %}
spiro-ip:
pip.installed:
- bin_env: {{pipbin}}
```
Interface
=========
A number of things are provided:
Grains
------
* `externalip4`, `externalip6`: Queries external services for your IP, useful
if the minion is behind a NAT or other complex network
Modules
-------
* `ip.addrs4`, `ip.addrs6`: Collates information about a minion's IP address
from several sources.
* `network.ipaddrs` / `network.ipaddrs6`
* AWS metadata (if you've set `metadata_server_grains: True`, see the [metadata grain](https://docs.saltstack.com/en/latest/ref/grains/all/salt.grains.metadata.html))
* `externalip4` / `externalip6` grains (above)
Configuration
=============
No configuration is required. However, as mentioned above, it might be useful to
set `metadata_server_grains: True`.
You may find it useful to set `ip.addrs4` / `ip.addrs6` as mine_functions so
that minions can get each other's IP address. Example:
```
mine_functions:
ip.addrs4: []
ip.addrs6: []
```
========
A quick and simple module to get information about the various IPs of your salt
minions.
This is meant to be installed on minions.
Installation
============
On minions, run `pip install spiro-ip`
Or, as a state:
```
{% if grains['pythonversion'][0] == 2 %}
{% set pipbin = "/usr/bin/pip2" %}
{% else %}
{% set pipbin = "/usr/bin/pip3" %}
{% endif %}
spiro-ip:
pip.installed:
- bin_env: {{pipbin}}
```
Interface
=========
A number of things are provided:
Grains
------
* `externalip4`, `externalip6`: Queries external services for your IP, useful
if the minion is behind a NAT or other complex network
Modules
-------
* `ip.addrs4`, `ip.addrs6`: Collates information about a minion's IP address
from several sources.
* `network.ipaddrs` / `network.ipaddrs6`
* AWS metadata (if you've set `metadata_server_grains: True`, see the [metadata grain](https://docs.saltstack.com/en/latest/ref/grains/all/salt.grains.metadata.html))
* `externalip4` / `externalip6` grains (above)
Configuration
=============
No configuration is required. However, as mentioned above, it might be useful to
set `metadata_server_grains: True`.
You may find it useful to set `ip.addrs4` / `ip.addrs6` as mine_functions so
that minions can get each other's IP address. Example:
```
mine_functions:
ip.addrs4: []
ip.addrs6: []
```
1 maintainer
Release files for spiro-ip 0.0.3
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| spiro-ip-0.0.3.tar.gz | 4.2 kB | Details |
Built distributions (wheels)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| spiro_ip-0.0.3-py3-none-any.whl | Python 3 | none | any | Details |
| spiro_ip-0.0.3-py2-none-any.whl | Python 2 | none | any | Details |
Total release size: 14.9 kB
Release files / spiro-ip-0.0.3.tar.gz
| Download URL | spiro-ip-0.0.3.tar.gz |
|---|---|
| Size | 4.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
703f75658398972594fa303b58c4176654342ec90335a771e46739f6cecdc98e
|
|
BLAKE2b-256 checksum How to use checksums |
a65de591d8b301fe2a966a33582fc9c37cdda77d44aa49ab7e31b60841420dd6
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/1.12.1 pkginfo/1.4.2 requests/2.20.1 setuptools/40.6.2 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.6.7
|
Release files / spiro_ip-0.0.3-py3-none-any.whl
| Download URL | spiro_ip-0.0.3-py3-none-any.whl |
|---|---|
| Size | 4.4 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
100fcc4793c58ba493627599a7a984508b07a9b248987988c78252f244f826bb
|
|
BLAKE2b-256 checksum How to use checksums |
7edab3badc7a71ccdfbde6ad36ae4ce1a544964fe820d3003ccbce615bba5658
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/1.12.1 pkginfo/1.4.2 requests/2.20.1 setuptools/40.6.2 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.6.7
|
Release files / spiro_ip-0.0.3-py2-none-any.whl
| Download URL | spiro_ip-0.0.3-py2-none-any.whl |
|---|---|
| Size | 6.3 kB |
| Tags | Python 2 |
|
SHA-256 checksum How to use checksums |
d34339cd40036d8db0c1f5c403cae51c83132491906da153294748b4f2821a52
|
|
BLAKE2b-256 checksum How to use checksums |
bf3723c493b22646fc734884f8f6e720f3f740601d0ef4a2d902aa385e4c2e84
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/1.12.1 pkginfo/1.4.2 requests/2.20.1 setuptools/40.6.2 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.6.7
|
