Note

Ce plugin fait partie du module f5networks.f5_modules collection (version 1.7.1).

Pour l'installer, utilisez : ansible-galaxy collection install f5networks.f5_modules.

Pour l'utiliser dans un playbook, spécifiez : f5networks.f5_modules.bigiq_device_info.

Nouveau dans la version 1.0.0 : de f5networks.f5_modules

  • Synopsis
  • Paramètres
  • Notes
  • Exemples
  • Valeurs de retour

Synopsis

  • Collecte des informations à partir des périphériques F5 BIG-IQ.
  • Ce module a été appelé bigiq_device_facts avant Ansible 2.9. L'utilisation n'a pas changé.

Paramètres

Paramètre Choix/par défaut Commentaires
gather_subsetliste / elements=string / obligatoire
    Choix :

  • tous les
  • applications
  • dispositifs gérés
  • licences de pool achetées
  • Registre des pools
  • system-info
  • vlans
  • !tous
  • !applications
  • !dispositifs gérés
  • !licences de pool achetées
  • !régénération des pools
  • !system-info
  • !vlans
Lorsqu'il est fourni, cet argument restreint les informations renvoyées à un sous-ensemble donné.Vous pouvez spécifier une liste de valeurs pour inclure un sous-ensemble plus large.Les valeurs peuvent également être utilisées avec une initiale ! pour spécifier qu'un sous-ensemble spécifique ne doit pas être collecté.
fournisseurdictionnaire ajouté dans la version 1.0.0 de f5networks.f5_modules Un objet dict contenant les détails de la connexion.
auth_providerchaîne de caractères Configure le fournisseur d'authentification pour pour obtenir les jetons d'authentification de l'appareil distant.Cette option est vraiment utilisée lorsque vous travaillez avec des appareils BIG-IQ.
no_f5_teemboolean
    Choix :

  • pas de
  • oui
Si yes, les données de télémétrie TEEM ne sont pas envoyées à F5.Vous pouvez omettre cette option en définissant la variable d'environnement F5_TEEM.
mot de passechaîne de caractères / obligatoire Le mot de passe du compte utilisateur utilisé pour se connecter au BIG-IP.Vous pouvez omettre cette option en définissant la variable d'environnement F5_PASSWORD.
alias : pass, pwd
serveurchaîne de caractères / requis L'hôte BIG-IP.Vous pouvez omettre cette option en définissant la variable d'environnement F5_SERVER.
port_serveurnombre entier Par défaut :
443
Le port du serveur BIG-IP.Vous pouvez omettre cette option en définissant la variable d'environnement F5_SERVER_PORT.
timeoutnombre entier Spécifie le délai d'attente en secondes pour la communication avec le périphérique réseau, que ce soit pour la connexion ou l'envoi de commandes. Si le délai d'attente est dépassé avant la fin de l'opération, le module émet une erreur.
transportchaîne de caractères
    Choix :

  • reste
Configure la connexion de transport à utiliser lors de la connexion au périphérique distant.
utilisateurchaîne de caractères / obligatoire Le nom d'utilisateur avec lequel se connecter au BIG-IP. Cet utilisateur doit avoir des privilèges administratifs sur le périphérique.Vous pouvez omettre cette option en définissant la variable d'environnement F5_USER.
validate_certsbooléen
    Choix :

  • pas de
  • oui
Si no, les certificats SSL ne sont pas validés. Utilisez cette option uniquement sur les sites contrôlés personnellement utilisant des certificats auto-signés.Vous pouvez omettre cette option en définissant la variable d'environnement F5_VALIDATE_CERTS.

Notes

Note

  • Ce module est pris en charge par toutes les versions de BIG-IQ.
  • Avec BIGIQ 7.0 et plus, quelques champs de métadonnées non inclus/pris en charge (par exemple, uptime, product_changelist, product_jobid).
  • Pour plus d'informations sur l'utilisation d'Ansible pour gérer les périphériques F5 Networks, voir . https://www.ansible.com/integrations/networks/f5.
  • Nécessite une version du logiciel BIG-IP >= 12.
  • Les modules F5 ne manipulent que la configuration en cours d'exécution du produit F5. Pour vous assurer que la configuration spécifique à BIG-IP persiste sur le disque, veillez à inclure au moins une tâche qui utilise le module F5. f5networks.f5_modules.bigip_config pour sauvegarder la configuration courante. Reportez-vous à la documentation du module pour l'utilisation correcte du module afin de sauvegarder votre configuration en cours d'exécution.

Exemples

-name: Collect BIG-IQ information
  bigiq_device_info:gather_subset:- system-info
      - vlans
    provider:server: lb.mydomain.com
      user: admin
      password: secret
  delegate_to: localhost

-name: Collect all BIG-IQ information
  bigiq_device_info:gather_subset:- all
    provider:server: lb.mydomain.com
      user: admin
      password: secret
  delegate_to: localhost

-name: Collect all BIG-IP information except trunks
  bigiq_device_info:gather_subset:- all
      -"!trunks"provider:server: lb.mydomain.com
      user: admin
      password: secret
  delegate_to: localhost

Valeurs de retour

Les valeurs de retour courantes sont documentées ici, les champs suivants sont uniques à ce module :

Clé Retourné Description
applicationscomplexe Quand managed-devices est spécifié dans gather_subset. Informations relatives à l'application
Echantillon : hachage/dictionnaire de valeurs
active_alertsnombre entier modifié Nombre d'alertes actives sur l'application.
mauvais_traficfloat modifié Pourcentage du trafic vers l'application qui est déterminé comme étant 'mauvais'.Cette valeur dépend de protection_mode soit activé.
Echantillon : 1.7498
mauvaise_croissance_du_traficbooléen modifié Si les alertes de mauvaise croissance du trafic sont configurées pour être déclenchées ou non.
connexionsfloat modifié Nombre actuel de connexions établies vers l'application.
Exemple : 3.06
enhanced_analyticsbooléen modifié Indique si l'analyse améliorée est activée ou non pour l'application.
Exemple : Vrai
santéchaîne de caractères modifié État de santé de l'application.
Echantillon : Bon
idchaîne de caractères modifié ID de l'application tel que connu par le BIG-IQ.
Exemple : 996baae8-5d1d-3662-8a2d-3612fa2aceae
nomchaîne de caractères modifié Nom de l'application.
Echantillon : site12http.exemple.com
new_connectionsfloat modifié Nombre de nouvelles connexions établies par seconde.
Echantillon : 0.35
mode_de_protectionchaîne de caractères modifié Le type de protection de F5 Web Application Security Service sur l'application.
Exemple : Non protégé
temps de réponsefloat modifié Temps de réponse mesuré de l'application en millisecondes.
Exemple : 0.02
statutchaîne de caractères modifié État actuel de l'application.
Echantillon : DEPLOYED
transactions_par_secondefloat modifié Mesure actuelle des transactions par seconde traitées par l'application.
Echantillon : 0.87
dispositifs_géréscomplexe Lorsque managed-devices est spécifié dans gather_subset. Informations relatives au dispositif géré.
Exemple : hachage/dictionnaire de valeurs
adressechaîne de caractères modifié Adresse où le dispositif a été découvert.
Exemple : 10.10.10.10
construirechaîne de caractères modifié Construction de la version.
Echantillon : 0.0.4
device_urichaîne de caractères modifié URI permettant d'atteindre l'interface de gestion de l'appareil.
Exemple : https://10.10.10.10:443
éditionchaîne de caractères modifié Chaîne d'édition de la version du produit.
Exemple : Final
nom_du_groupechaîne de caractères modifié Groupe BIG-IQ dont le périphérique est membre.
Exemple : cm-bigip-allBigIpDevices
nom d'hôtechaîne de caractères modifié Nom d'hôte découvert de l'appareil.
Echantillon : tier2labB1.lab.fp.foo.com
https_portentier modifié Port HTTPS disponible sur l'interface de gestion de l'appareil.
Exemple : 443
is_clusteredbooléen modifié Indique si le périphérique est mis en grappe ou non.
is_license_expiredbooléen modifié Indique si la licence du périphérique est expirée ou non.
Exemple : Vrai
est_virtuelboolean modifié Indique si le périphérique est une édition virtuelle ou non.
Exemple : Vrai
machine_idchaîne de caractères modifié Identifiant spécifique à la machine attribué à ce périphérique par BIG-IQ.
Echantillon : c141bc88-f734-4434-be64-a3e9ea98356e
adresse_de_gestionchaîne de caractères modifié Adresse IP de l'interface de gestion sur l'appareil.
Exemple : 10.10.10.10
mcp_device_namechaîne de caractères modifié Nom du périphérique tel que connu par MCPD sur le BIG-IP.
Exemple :/Common/tier2labB1.lab.fp.foo.com
produitchaîne de caractères modifié Produit sous lequel le périphérique géré est identifié.
Echantillon : BIG-IP
rest_framework_versionchaîne de caractères modifié Version du framework REST exécutée sur l'appareil
Exemple : 13.1.1-0.0.4
self_linkchaîne de caractères modifié Référence interne au dispositif géré dans BIG-IQ.
Exemple : https://localhost/mgmt/shared/resolver/device-groups/cm-bigip-allBigIpDevices/devices/c141bc88-f734-4434-be64-a3e9ea98356e
créneaux horairesdictionnaire modifié Volumes sur le périphérique et versions des logiciels installés dans ces volumes.
Echantillon :{'build' : '0.0.4', 'isActive' : 'yes', 'product' : 'BIG-IP', 'version' : '13.1.1', 'volume' : 'HD1.1'}
étatchaîne de caractères modifié État de l'appareil.
Echantillon : ACTIF
balisesdictionnaire modifié Balises diverses qui sont attribuées au dispositif.
Exemple :{'BIGIQ_SSG_name' : 'tim-ssg', 'BIGIQ_tier_2_device' : '2018-08-22T13:30:47.693-07:00'}
trust_domain_guidchaîne de caractères modifié GUID du domaine de confiance dont fait partie le périphérique.
Exemple : 40ddf541-e604-4905-bde3005056813e36
uuidchaîne de caractères modifié UUID de l'appareil dans BIG-IQ.
Exemple : c141bc88-f734-4434-be64-a3e9ea98356e
versionchaîne de caractères modifié Version du TMOS installé sur le dispositif.
Echantillon : 13.1.1
licences_pool_achetéescomplexe Lorsque purchased-pool-licenses est spécifié dans gather_subset. Informations relatives à la licence de pool achetée.
Echantillon : hachage/dictionnaire de valeurs
base_reg_keychaîne de caractères modifié Clé d'enregistrement de base du pool acheté.
Echantillon : XXXXX-XXXXX-XXXXX-XXXXX-XXXXXXX
dossierchaîne de caractères modifié Dossier de la licence de pool achetée.
Echantillon : d6bd4b8ba5...e9a1a1199b73af9932948a
heure_de_fin_date_d'évaluationchaîne de caractères modifié Date à laquelle la licence d'évaluation prend fin.
Exemple : 2018-10-11T00:00:00-07:00
évaluation_début_date_heurechaîne de caractères modifié Date à laquelle la licence d'évaluation commence.
Echantillon : 2018-09-09T00:00:00-07:00
free_device_licensesentier modifié Nombre de licences libres restantes.
Echantillon : 34
date_fin_de_licencechaîne de caractères modifié Date à laquelle la licence expire.
Echantillon : 2018-10-11T00:00:00-07:00
licence_début_date_heurechaîne de caractères modifié Date à laquelle la licence débute.
Exemple : 2018-09-09T00:00:00-07:00
heure_date_licencechaîne de caractères modifié Horodatage auquel le pool a été licencié.
Echantillon : 2018-09-10T00:00:00-07:00
version_licenciéechaîne de caractères modifié Version de BIG-IQ qui fait l'objet d'une licence.
Echantillon : 6.0.1
nomchaîne de caractères modifié Nom du pool acheté
Echantillon : mon-pool1
clé d'enregistrementchaîne de caractères modifié Clé de licence de pool achetée.
Echantillon : XXXXX-XXXXX-XXXXX-XXXXX-XXXXXXX
étatchaîne de caractères modifié État de la licence de pool achetée.
Echantillon : LICENSEE
total_device_licensesnombre entier modifié Nombre total de licences dans le pool.
Echantillon : 40
uuidchaîne de caractères modifié UUID de la licence de pool achetée
Echantillon : b2112329-cba7-4f1f-9a26-fab9be416d60
vendeurchaîne de caractères modifié Vendeur qui a fourni la licence
Echantillon : F5 Networks, Inc
regkey_poolscomplexe Lorsque regkey-pools est spécifié dans gather_subset. Informations relatives au pool de clés.
Exemple : hachage/dictionnaire de valeurs
idchaîne de caractères modifié ID du pool de regkey.
Echantillon : 4f9b565c-0831-4657-b6c2-6dde6182a502
nomchaîne de caractères modifié Nom du pool de regkey.
Echantillon : pool1
offrescomplexe succès Liste des offres dans le pool.
Echantillon : hachage/dictionnaire de valeurs
dossierchaîne de caractères modifié Dossier de la licence.
Echantillon : d6bd4b8ba5...e9a1a1199b73af9932948a
heure_de_fin_date_d'évaluationchaîne de caractères modifié Date à laquelle la licence d'évaluation prend fin.
Exemple : 2018-10-11T00:00:00-07:00
évaluation_début_date_heurechaîne de caractères modifié Date à laquelle la licence d'évaluation commence.
Echantillon : 2018-09-09T00:00:00-07:00
heure_fin_de_la_licencechaîne de caractères modifié Date à laquelle la licence expire.
Echantillon : 2018-10-11T00:00:00-07:00
licence_start_date_timechaîne de caractères modifié Date à laquelle la licence débute.
Exemple : 2018-09-09T00:00:00-07:00
heure_date_licencechaîne de caractères modifié Timestamp que la regkey a été autorisée.
Exemple : 2018-09-10T00:00:00-07:00
version_licenciéechaîne de caractères modifié Version de BIG-IQ qui fait l'objet d'une licence.
Echantillon : 6.0.1
nomchaîne de caractères modifié Nom de la clé de registre.
Exemple : regkey1
clé d'enregistrementchaîne de caractères modifié Clé de licence d'enregistrement.
Echantillon : XXXXX-XXXXX-XXXXX-XXXXX-XXXXXXX
étatchaîne de caractères modifié État de la licence de la regkey
Echantillon : LICENSED
total_offertesnombre entier modifié Nombre total d'offres dans le pool
Echantillon : 10
system_infocomplexe Lorsque system-info est spécifié dans gather_subset. Informations relatives à l'info système.
Exemple : hachage/dictionnaire de valeurs
adresse_mac_de_basechaîne de caractères modifié Adresse de contrôle d'accès au support (adresse MAC) de l'appareil.
Echantillon : fa:16:3e:c3:42:6f
châssis_sériechaîne de caractères succès Numéro de série du châssis
Echantillon : 11111111-2222-3333-444444444444
informations sur le matérielcomplexe modifié Informations relatives au matériel (lecteurs et unités centrales) du système.
modèlechaîne de caractères succès Le modèle du matériel.
Echantillon : Disque virtuel
nomchaîne de caractères succès Le nom du matériel.
Exemple : HD1
typechaîne de caractères succès Le type de matériel.
Echantillon : disque physique
versionscomplexe succès Propriétés spécifiques au matériel
nomchaîne de caractères succès Nom de la propriété
Exemple : Taille
versionchaîne de caractères succès Valeur de la propriété
Exemple : 154.00G
host_board_part_revisionchaîne de caractères succès Révision de la carte hôte.
host_board_serialchaîne de caractères succès Numéro de série de la carte hôte.
est_admin_mot_de_passe_changéboolean changé Si le mot de passe administrateur a été modifié par rapport à sa valeur par défaut ou non.
Exemple : Vrai
est_root_password_changedbooléen changé Si le mot de passe root a été modifié par rapport à sa valeur par défaut ou non.
is_system_setupbooléen modifié Indique si le système a été configuré ou non.
Echantillon : Vrai
nom_marketingchaîne de caractères modifié Nom commercial de la plate-forme du dispositif.
Echantillon : BIG-IQ Virtual Edition
paquet_editionchaîne de caractères modifié Affiche l'édition du logiciel.
Echantillon : Point Release 7
version_du_paquetchaîne de caractères succès Une chaîne de caractères combinant le product_build et product_build_date.
Exemple : Build 0.0.1 - Tue May 15 15:26:30 PDT 2018
plateformechaîne de caractères succès Identifiant de la plate-forme.
Echantillon : Z100
produit_constructionchaîne de caractères succès Version de construction de la version de sortie.
Echantillon : 0.0.1
produit_build_datechaîne de caractères succès Date de construction lisible par l'homme.
Echantillon : Tue May 15 15:26:30 PDT 2018
produit_construitnombre entier succès Horodatage Unix de la date à laquelle le produit a été construit.
Echantillon : 180515152630
produit_changelistnombre entier succès Changelist à partir duquel le produit se ramifie.Non pris en charge avec BIGIQ 7.0 et les versions ultérieures.
Exemple : 2557198
code_produitchaîne de caractères succès Code identifiant le produit.
Echantillon : BIG-IQ
produit_jobidnombre entier succès ID de la tâche qui a construit la version du produit.Non pris en charge avec BIGIQ 7.0 et les versions ultérieures.
Exemple : 1012030
version_produitchaîne de caractères succès Version majeure du produit du logiciel en cours d'exécution.
Echantillon : 6.0.0
révision_partie_du_tableau_commutateurchaîne de caractères succès Révision de la carte de commutation.
switch_board_serialchaîne de caractères succès Numéro de série du tableau de distribution.
heurecomplexe changé Mappage de l'information sur l'heure actuelle à des touches spécifiques portant un nom d'heure.
journombre entier modifié Le jour actuel du mois, sous forme numérique.
Exemple : 7
heurenombre entier modifié L'heure actuelle de la journée sous forme de 24 heures.
Exemple : 18
minutenombre entier modifié La minute actuelle de l'heure.
Echantillon : 16
moisnombre entier modifié Le mois en cours, sous forme numérique.
Exemple : 6
deuxièmenombre entier modifié La seconde actuelle de la minute.
Echantillon : 51
annéenombre entier modifié L'année en cours sous forme de 4 chiffres.
Exemple : 2018
temps de fonctionnementnombre entier succès Temps, en secondes, depuis que le système a démarré.Non pris en charge avec BIGIQ 7.0 et les versions ultérieures.
Exemple : 603202
vlanscomplexe Lorsque vlans est spécifié dans gather_subset. Liste des informations sur les réseaux locaux virtuels.
Exemple : hachage/dictionnaire de valeurs
auto_lasthopchaîne de caractères modifié Permet au système d'envoyer le trafic de retour à l'adresse MAC qui a transmis la demande, même si la table de routage pointe vers un réseau ou une interface différente.
Exemple : activé
cmp_hash_algorithmechaîne de caractères modifié Spécifie la manière dont le trafic sur le VLAN sera désagrégé.
Exemple : par défaut
descriptionchaîne de caractères modifié Description du réseau local virtuel.
Exemple : Mon vlan
failsafe_actionchaîne de caractères modifié Action que le système doit entreprendre lorsque le mécanisme de sécurité intégrée est déclenché.
Exemple : redémarrer
failsafe_enabledbooléen modifié Indique si la sécurité intégrée est activée ou non.
Echantillon : Vrai
failsafe_timeoutentier modifié Nombre de secondes pendant lesquelles une unité active peut fonctionner sans détecter de trafic réseau sur ce VLAN avant de lancer un basculement.
Exemple : 90
if_indexnombre entier modifié Index attribué à ce VLAN. Il s'agit d'un identifiant unique attribué pour tous les objets affichés dans le SNMP IF-MIB.
Exemple : 176
interfacescomplexe modifié Liste des interfaces et des trunks balisés ou non balisés que vous souhaitez configurer pour le VLAN.
chemin_completchaîne de caractères modifié Nom complet de la ressource tel que connu par BIG-IP.
Exemple : 1.3
nomchaîne de caractères modifié Nom relatif de la ressource dans BIG-IP.
Exemple : 1.3
balisébooléen modifié Indique si l'interface est balisée ou non.
learning_modechaîne de caractères modifié Si les ports de commutateur placés dans le VLAN sont configurés pour l'apprentissage du commutateur, le transfert uniquement, ou abandonnés.
Exemple : enable-forward
mtuentier modifié Unité de transition maximale (MTU) spécifique pour le réseau local virtuel.
Exemple : 1500
sflow_poll_intervalnombre entier modifié Intervalle maximal en secondes entre deux sondages.
sflow_poll_interval_globalbooléen modifié Si le paramètre global de poll-intervalle de VLAN, remplace le paramètre de poll-intervalle de niveau objet.
sflow_sampling_ratenombre entier modifié Rapport entre les paquets observés et les échantillons générés.
sflow_sampling_rate_globalbooléen modifié Si le paramètre de taux d'échantillonnage global du réseau local virtuel, remplace le paramètre de taux d'échantillonnage au niveau de l'objet.
Echantillon : Vrai
source_check_enabledbooléen modifié Spécifie que seules les connexions qui ont une route de retour dans la table de routage sont acceptées.
Exemple : Vrai
baliseentier modifié Numéro de balise pour le réseau local virtuel.
Exemple : 30
adresse_mac_vraichaîne de caractères modifié Adresse de contrôle d'accès au support (MAC) pour l'interface de numéro le plus bas affectée à ce VLAN.
Exemple : fa:16:3e:10:da:ff

Auteurs

  • Tim Rupp (@caphrim007)