Модуль community.general.ipbase_info — Получение геолокации IP-адреса и других данных хоста с помощью API ipbase.com

Примечание

Этот модуль является частью коллекции community.general (версия 9.5.0).

Эта коллекция может быть уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install community.general.

Чтобы использовать его в плейбуке, укажите: community.general.ipbase_info.

Новая функция в community.general 7.0.0

Описание
Параметры
Атрибуты
Примечания
Примеры
Возвращаемые значения

Описание

Получение геолокации IP-адреса и других данных хоста с помощью API ipbase.com

Параметры

Параметр	Комментарии
apikey строка	Ключ API для запроса, если вам необходимо больше запросов.
hostname логическое значение	Если параметр `hostname` установлен в `true`, ответ API будет содержать имя хоста IP-адреса. Варианты: `false` ← (по умолчанию) `true`
ip строка	IP-адрес, для которого вы хотите получить информацию. Если не указан, API автоматически определит IP-адрес.
language строка	Код языка ISO Alpha 2 для локализации данных IP По умолчанию: `"en"`

Атрибуты

Атрибут	Поддержка	Описание
check_mode	Поддержка: полная Это действие не изменяет состояние.	Может работать в режиме `check_mode` и возвращать прогноз состояния изменений без модификации целевого объекта.
diff_mode	Поддержка: Н/Д Это действие не изменяет состояние.	Вернет детали изменений (или, возможно, требующих изменений в `check_mode`), когда используется режим diff.

Примечания

Примечание

См. https://ipbase.com/ для получения дополнительной информации.

Примеры

- name: "Get IP geolocation information of the primary outgoing IP"
  community.general.ipbase_info:
  register: my_ip_info

- name: "Get IP geolocation information of a specific IP"
  community.general.ipbase_info:
    ip: "8.8.8.8"
  register: my_ip_info


- name: "Get IP geolocation information of a specific IP with all other possible parameters"
  community.general.ipbase_info:
    ip: "8.8.8.8"
    apikey: "xxxxxxxxxxxxxxxxxxxxxx"
    hostname: true
    language: "de"
  register: my_ip_info

Возвращаемые значения

Общие возвращаемые значения описаны здесь, следующие поля уникальны для данного модуля:

Ключ	Описание
data словарь	Результат парсинга JSON от ipbase.com. Для подробной структуры ответа, пожалуйста, обратитесь к https://ipbase.com/docs/info. Возвращается: success Пример: {"connection": {"asn": 13335, "isp": "APNIC Research and Development", "organization": "Cloudflare, Inc.", "range": "1.1.1.1/32"}, "domains": {"count": 10943, "domains": ["eliwise.academy", "accountingprose.academy", "pistola.academy", "1and1-test-ntlds-fr.accountant", "omnergy.africa"]}, "hostname": "one.one.one.one", "ip": "1.1.1.1", "location": {"city": {"alpha2": null, "fips": "644000", "geonames_id": 5368753, "hasc_id": null, "name": "Los Angeles", "name_translated": "Los Angeles", "wikidata_id": "Q65"}, "continent": {"code": "NA", "name": "North America", "name_translated": "North America"}, "country": {"alpha2": "US", "alpha3": "USA", "calling_codes": ["+1"], "currencies": [{"code": "USD", "decimal_digits": 2, "name": "US Dollar", "name_plural": "US dollars", "rounding": 0, "symbol": "$", "symbol_native": "$"}], "emoji": "...", "fips": "US", "geonames_id": 6252001, "hasc_id": "US", "ioc": "USA", "is_in_european_union": false, "languages": [{"name": "English", "name_native": "English"}], "name": "United States", "name_translated": "United States", "timezones": ["America/New_York", "America/Detroit", "America/Kentucky/Louisville", "America/Kentucky/Monticello", "America/Indiana/Indianapolis", "America/Indiana/Vincennes", "America/Indiana/Winamac", "America/Indiana/Marengo", "America/Indiana/Petersburg", "America/Indiana/Vevay", "America/Chicago", "America/Indiana/Tell_City", "America/Indiana/Knox", "America/Menominee", "America/North_Dakota/Center", "America/North_Dakota/New_Salem", "America/North_Dakota/Beulah", "America/Denver", "America/Boise", "America/Phoenix", "America/Los_Angeles", "America/Anchorage", "America/Juneau", "America/Sitka", "America/Metlakatla", "America/Yakutat", "America/Nome", "America/Adak", "Pacific/Honolulu"], "wikidata_id": "Q30"}, "geonames_id": 5332870, "latitude": 34.053611755371094, "longitude": -118.24549865722656, "region": {"alpha2": "US-CA", "fips": "US06", "geonames_id": 5332921, "hasc_id": "US.CA", "name": "California", "name_translated": "California", "wikidata_id": "Q99"}, "zip": "90012"}, "range_type": {"description": "Public address", "type": "PUBLIC"}, "security": {"is_abuser": true, "is_anonymous": false, "is_bot": false, "is_datacenter": false, "is_icloud_relay": false, "is_known_attacker": true, "is_proxy": false, "is_spam": false, "is_tor": false, "is_vpn": false, "threat_score": 100}, "timezone": {"code": "PDT", "current_time": "2023-05-04T04:30:28-07:00", "gmt_offset": -25200, "id": "America/Los_Angeles", "is_daylight_saving": true}, "tlds": [".us"], "type": "v4"}

Ключ

Описание

data

словарь

Результат парсинга JSON от ipbase.com. Для подробной структуры ответа, пожалуйста, обратитесь к https://ipbase.com/docs/info.

Возвращается: success

Пример: {"connection": {"asn": 13335, "isp": "APNIC Research and Development", "organization": "Cloudflare, Inc.", "range": "1.1.1.1/32"}, "domains": {"count": 10943, "domains": ["eliwise.academy", "accountingprose.academy", "pistola.academy", "1and1-test-ntlds-fr.accountant", "omnergy.africa"]}, "hostname": "one.one.one.one", "ip": "1.1.1.1", "location": {"city": {"alpha2": null, "fips": "644000", "geonames_id": 5368753, "hasc_id": null, "name": "Los Angeles", "name_translated": "Los Angeles", "wikidata_id": "Q65"}, "continent": {"code": "NA", "name": "North America", "name_translated": "North America"}, "country": {"alpha2": "US", "alpha3": "USA", "calling_codes": ["+1"], "currencies": [{"code": "USD", "decimal_digits": 2, "name": "US Dollar", "name_plural": "US dollars", "rounding": 0, "symbol": "$", "symbol_native": "$"}], "emoji": "...", "fips": "US", "geonames_id": 6252001, "hasc_id": "US", "ioc": "USA", "is_in_european_union": false, "languages": [{"name": "English", "name_native": "English"}], "name": "United States", "name_translated": "United States", "timezones": ["America/New_York", "America/Detroit", "America/Kentucky/Louisville", "America/Kentucky/Monticello", "America/Indiana/Indianapolis", "America/Indiana/Vincennes", "America/Indiana/Winamac", "America/Indiana/Marengo", "America/Indiana/Petersburg", "America/Indiana/Vevay", "America/Chicago", "America/Indiana/Tell_City", "America/Indiana/Knox", "America/Menominee", "America/North_Dakota/Center", "America/North_Dakota/New_Salem", "America/North_Dakota/Beulah", "America/Denver", "America/Boise", "America/Phoenix", "America/Los_Angeles", "America/Anchorage", "America/Juneau", "America/Sitka", "America/Metlakatla", "America/Yakutat", "America/Nome", "America/Adak", "Pacific/Honolulu"], "wikidata_id": "Q30"}, "geonames_id": 5332870, "latitude": 34.053611755371094, "longitude": -118.24549865722656, "region": {"alpha2": "US-CA", "fips": "US06", "geonames_id": 5332921, "hasc_id": "US.CA", "name": "California", "name_translated": "California", "wikidata_id": "Q99"}, "zip": "90012"}, "range_type": {"description": "Public address", "type": "PUBLIC"}, "security": {"is_abuser": true, "is_anonymous": false, "is_bot": false, "is_datacenter": false, "is_icloud_relay": false, "is_known_attacker": true, "is_proxy": false, "is_spam": false, "is_tor": false, "is_vpn": false, "threat_score": 100}, "timezone": {"code": "PDT", "current_time": "2023-05-04T04:30:28-07:00", "gmt_offset": -25200, "id": "America/Los_Angeles", "is_daylight_saving": true}, "tlds": [".us"], "type": "v4"}

Авторы

Dominik Kukacka (@dominikkukacka)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/general/ipbase_info_module.html