Note

Ce plugin fait partie de la collection communauté.réseau (version 2.0.1).

Pour l'installer, utilisez : ansible-galaxy collection install community.network.

Pour l'utiliser dans un playbook, spécifiez : community.network.avi_pool.

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

Synopsis

Exigences

Les exigences ci-dessous sont nécessaires sur l'hôte qui exécute ce module.

  • avisdk

Paramètres

Paramètre Choix/par défaut Commentaires
a_poolchaîne de caractères Nom de l'application de cloud conteneur qui constitue un pool dans une configuration de pool a-b, si elle est différente de vs app.Champ déprécié dans 18.1.2.
ab_poolchaîne de caractères Configuration du pool A/b. Champ déprécié dans la version 18.1.2.
ab_prioritychaîne de caractères Priorité de ce pool dans une paire de pools a-b.Utilisé en interne.Champ déprécié dans 18.1.2.
politique_analytiquechaîne de caractères Détermine les paramètres d'analyse pour le pool.Champ introduit dans 18.1.5, 18.2.1.
analytics_profile_refchaîne de caractères Spécifie les paramètres liés à l'analytique.C'est une référence à un objet de type analyticsprofile.Champ introduit dans 18.1.4,18.2.1.
api_contextdictionnaire Contexte de l'API d'Avi qui comprend l'ID de la session actuelle et le jeton CSRF.Cela permet à l'utilisateur d'effectuer une seule connexion et de réutiliser la session.
api_versionchaîne de caractères Par défaut :
"16.4.4"
Version de l'API Avi à utiliser pour l'API et les objets Avi.
apic_epg_namechaîne de caractères Synchroniser les membres de cisco apic epg avec les serveurs de pool.
application_persistence_profile_refchaîne de caractères La persistance permettra de s'assurer que le même utilisateur colle au même serveur pendant une durée souhaitée.C'est une référence à un objet de type applicationpersistenceprofile.
autoscale_launch_config_refchaîne de caractères S'il est configuré, alors avi déclenchera l'orchestration de la création et de la suppression des serveurs de pool.Il est uniquement pris en charge pour les clouds de conteneurs comme mesos, openshift, kubernetes, docker, etc.Il s'agit d'une référence à un objet de type autoscalelaunchconfig.
autoscale_networkschaîne de caractères Ids de réseau pour la configuration de lancement.
autoscale_policy_refchaîne de caractères Référence à la politique autoscale du serveur.Il s'agit d'une référence à un objet de type serverautoscalepolicy.
avi_api_patch_opchaîne de caractères
    Choix :

  • ajouter
  • remplacer
  • supprimer
Opération de patch à utiliser lorsque vous utilisez avi_api_update_method comme patch.
avi_api_update_methodchaîne de caractères
    Choix :

  • mettre
  • patch
La méthode par défaut pour la mise à jour des objets est HTTP PUT.Le réglage sur patch annulera ce comportement pour utiliser HTTP PATCH.
avi_credentialsdictionnaire Dictionnaire Avi Credentials qui peut être utilisé à la place de l'énumération des détails de connexion du contrôleur Avi.
api_versionchaîne de caractères Par défaut :
"16.4.4"
Version du contrôleur Avi
contrôleurchaîne de caractères IP ou SQDN du contrôleur Avi
csrftokenchaîne de caractères Csrftoken de l'API du contrôleur Avi pour réutiliser la session existante avec l'id de la session.
mot de passechaîne de caractères Mot de passe du contrôleur Avi
portchaîne de caractères Port du contrôleur Avi
session_idchaîne de caractères Id de session API du contrôleur Avi pour réutiliser une session existante avec csrftoken.
locatairechaîne de caractères Par défaut :
"admin"
Locataire du contrôleur Avi
tenant_uuidchaîne de caractères UUID du locataire du contrôleur Avi
timeoutchaîne de caractères Par défaut :
300
Délai de demande du contrôleur Avi
jetonchaîne de caractères Jeton API du contrôleur Avi
nom d'utilisateurchaîne de caractères Nom d'utilisateur du contrôleur Avi
avi_disable_session_cache_as_factbooléen
    Choix :

  • pas de
  • oui
Il désactive la mise en cache des informations de session avi comme un fait.
estimation_de_la_capacitébooléen
    Choix :

  • pas de
  • oui
Estimation en ligne de la capacité des serveurs.La valeur par défaut lorsqu'elle n'est pas spécifiée dans l'API ou le module est interprétée par Avi Controller comme False.
estimation_de_la_capacité_ttfb_threshchaîne de caractères Le temps maximum jusqu'au premier octet d'un serveur.Les valeurs autorisées sont 1-5000.Les valeurs spéciales sont 0 - 'automatique'.La valeur par défaut lorsqu'elle n'est pas spécifiée dans l'API ou le module est interprétée par Avi Controller comme 0.
cloud_config_cksumchaîne de caractères Somme de contrôle de la configuration du cloud pour le pool.Définie en interne par le connecteur cloud.
cloud_refchaîne de caractères Il s'agit d'une référence à un objet de type cloud.
conn_pool_propertieschaîne de caractères Propriétés du pool de connexion.Champ introduit dans la version 18.2.1.
connexion_ramp_durationchaîne de caractères Durée pendant laquelle les nouvelles connexions seront progressivement augmentées vers un serveur récemment mis en ligne.Utile pour les algorithmes lb qui sont moins basés sur la connexion.Les valeurs autorisées sont 1-300.Les valeurs spéciales sont 0 - 'immédiat'.La valeur par défaut lorsqu'elle n'est pas spécifiée dans l'API ou le module est interprétée par Avi Controller comme 10.
contrôleurchaîne de caractères Par défaut :
""
Adresse IP ou nom d'hôte du contrôleur. La valeur par défaut est la variable d'environnement AVI_CONTROLLER.
created_bychaîne de caractères Nom du créateur.
port_serveur_par défautchaîne de caractères Le trafic envoyé aux serveurs utilisera ce port de serveur de destination à moins qu'il ne soit remplacé par l'attribut de port spécifique du serveur.La case à cocher ssl active le cryptage avi à serveur.Les valeurs autorisées sont 1-65535.La valeur par défaut lorsqu'elle n'est pas spécifiée dans l'API ou le module est interprétée par Avi Controller comme 80.
delete_server_on_dns_refreshbooléen
    Choix :

  • pas de
  • oui
Indique si les ips existants sont désactivés(false) ou supprimés(true) lors du rafraîchissement du nom d'hôte dnsdetail -- lors d'un rafraîchissement dns, certains ips définis sur le pool peuvent ne plus être renvoyés par le résolveur.Ces ips sont supprimés du pool lorsque ce bouton est défini sur true.Ils sont désactivés, si le bouton est défini sur false.Champ introduit en 18.2.3.La valeur par défaut lorsqu'elle n'est pas spécifiée dans l'API ou le module est interprétée par Avi Controller comme True.
descriptionchaîne de caractères Une description de la piscine.
nom_domainechaîne de caractères Liste séparée par des virgules des noms de domaine qui seront utilisés pour vérifier les noms communs ou les noms alternatifs de sujets présentés par les certificats de serveur.Elle est effectuée uniquement lorsque la vérification du nom commun host_check_enabled est activée.
est_ouestbooléen
    Choix :

  • pas de
  • oui
Configuration héritée de virtualservice.
activébooléen
    Choix :

  • pas de
  • oui
Activer ou désactiver le pool.La désactivation mettra fin à toutes les connexions ouvertes et mettra en pause les moniteurs de santé.La valeur par défaut lorsqu'elle n'est pas spécifiée dans l'API ou le module est interprétée par Avi Controller comme True.
groupes_autoscale_externeschaîne de caractères Noms des groupes auto-scale externes pour les serveurs de pool.Actuellement disponible uniquement pour aws et azure.Champ introduit dans 17.1.2.
fail_actionchaîne de caractères Activez une action - fermeture de la connexion, redirection http ou réponse http locale - lorsqu'une défaillance du pool se produit.Par défaut, une connexion sera fermée, au cas où le pool connaîtrait une défaillance.
fewest_tasks_feedback_delaychaîne de caractères Périodicité de la rétroaction pour l'algorithme de sélection du serveur le plus petit nombre de tâches.Les valeurs autorisées sont 1-300.La valeur par défaut lorsqu'elle n'est pas spécifiée dans l'API ou le module est interprétée par Avi Controller comme 10.
graceful_disable_timeoutchaîne de caractères Utilisé pour désactiver gracieusement un serveur.Le service virtuel attend le temps spécifié avant de terminer les connexions existantes aux serveurs qui sont désactivés.Les valeurs autorisées sont 1-7200.Les valeurs spéciales sont 0 - 'immédiat', -1 - 'infini'.La valeur par défaut lorsqu'elle n'est pas spécifiée dans l'API ou le module est interprétée par Avi Controller comme 1.
gslb_sp_enabledbooléen
    Choix :

  • pas de
  • oui
Indique si le pool est un pool de persistance de site.Champ introduit dans 17.2.1.
health_monitor_refschaîne de caractères Vérifiez la santé du serveur en appliquant un ou plusieurs moniteurs de santé.Les moniteurs actifs génèrent un trafic synthétique à partir de chaque moteur de service et marquent un serveur à la hausse ou à la baisse en fonction de la réponse.Le moniteur passif écoute uniquement la communication client-serveur.Il augmente ou diminue le ratio du trafic destiné à un serveur en fonction des réponses réussies.C'est une référence à un objet de type healthmonitor.
host_check_enabledbooléen
    Choix :

  • pas de
  • oui
Activer la vérification du nom commun pour le certificat du serveur.Si elle est activée et qu'aucun nom de domaine explicite n'est spécifié, avi utilisera l'en-tête d'hôte entrant pour faire la correspondance.La valeur par défaut lorsqu'elle n'est pas spécifiée dans l'API ou le module est interprétée par Avi Controller comme False.
inline_health_monitorbooléen
    Choix :

  • pas de
  • oui
Le moniteur passif surveillera les connexions et les demandes client-serveur et ajustera la charge de trafic vers les serveurs en fonction des réponses réussies.Cela peut modifier le comportement attendu de la méthode lb, comme le round robin.La valeur par défaut lorsqu'elle n'est pas spécifiée dans l'API ou le module est interprétée par Avi Controller comme True.
ipaddrgroup_refchaîne de caractères Utiliser la liste des serveurs du groupe d'adresses ip.C'est une référence à un objet de type ipaddrgroup.
lb_algorithmechaîne de caractères L'algorithme d'équilibrage de charge choisira un serveur dans la liste des serveurs disponibles du pool. Options Enum - LB_ALGORITHM_LEAST_CONNECTIONS, LB_ALGORITHM_ROUND_ROBIN, LB_ALGORITHM_FASTEST_RESPONSE, LB_ALGORITHM_CONSISTENT_HASH,LB_ALGORITHM_LEAST_LOAD, LB_ALGORITHM_FEWEST_SERVERS, LB_ALGORITHM_RANDOM, LB_ALGORITHM_FEWEST_TASKS, LB_ALGORITHM_NEAREST_SERVER,LB_ALGORITHM_CORE_AFFINITY, LB_ALGORITHM_TOPOLOGY. La valeur par défaut lorsqu'elle n'est pas spécifiée dans l'API ou le module est interprétée par Avi Controller comme LB_ALGORITHM_LEAST_CONNECTIONS.
lb_algorithme_consistant_hash_hdrchaîne de caractères Nom de l'en-tête Http à utiliser pour la clé de hachage.
lb_algorithmem_core_nonaffinitéchaîne de caractères Degré de non-affinité pour la sélection du serveur basée sur l'affinité du noyau.Les valeurs autorisées sont 1-65535.Champ introduit en 17.1.3.La valeur par défaut lorsqu'elle n'est pas spécifiée dans l'API ou le module est interprétée par Avi Controller comme étant 2.
lb_algorithm_hashchaîne de caractères Critères utilisés comme clé pour déterminer le hachage entre le client et le serveur. Options Enum - LB_ALGORITHM_CONSISTENT_HASH_SOURCE_IP_ADDRESS, LB_ALGORITHM_CONSISTENT_HASH_SOURCE_IP_ADDRESS_AND_PORT,LB_ALGORITHM_CONSISTENT_HASH_URI, LB_ALGORITHM_CONSISTENT_HASH_CUSTOM_HEADER, LB_ALGORITHM_CONSISTENT_HASH_CUSTOM_STRING, LB_ALGORITHM_CONSISTENT_HASH_CALLID. La valeur par défaut lorsqu'elle n'est pas spécifiée dans l'API ou le module est interprétée par Avi Controller comme LB_ALGORITHM_CONSISTENT_HASH_SOURCE_IP_ADDRESS.
lookup_server_by_nameboolean
    Choix :

  • pas de
  • oui
Allow server lookup by name.Field introduced in 17.1.11,17.2.4.Default value when not specified in API or module is interpreted by Avi Controller as False.
max_concurrent_connexions_par_serveurchaîne de caractères Le nombre maximum de connexions simultanées autorisées à chaque serveur au sein du pool.Note valeur appliquée ne sera pas inférieure au nombre de moteurs de service sur lesquels le pool est placé.Si elle est définie à 0, aucune limite n'est appliquée.La valeur par défaut lorsqu'elle n'est pas spécifiée dans l'API ou le module est interprétée par Avi Controller comme 0.
max_conn_rate_per_serverchaîne de caractères Taux limite de connexions à chaque serveur.
min_health_monitors_upchaîne de caractères Nombre minimal de moniteurs de santé à l'état actif pour marquer le serveur en état actif.Champ introduit dans 18.2.1, 17.2.12.
min_servers_upchaîne de caractères Nombre minimum de serveurs dans l'état up pour marquer le pool up.Champ introduit dans 18.2.1, 17.2.12.
nomchaîne de caractères / obligatoire Le nom du pool.
réseauxchaîne de caractères (à usage interne) réseaux désignés comme contenant des serveurs pour ce pool.Les serveurs peuvent être encore réduits par un filtre.Ce champ est utilisé en interne par avi, non modifiable par l'utilisateur.
nsx_securitygroupchaîne de caractères Une liste de groupes de services nsx où sont créés les serveurs pour le pool.Champ introduit dans 17.1.1.
mot de passechaîne de caractères Par défaut :
""
Mot de passe de l'utilisateur Avi dans le contrôleur Avi. La valeur par défaut est la variable d'environnement AVI_PASSWORD.
pki_profile_refchaîne de caractères Avi va valider le certificat ssl présent par un serveur par rapport au profil pki sélectionné.C'est une référence à un objet de type pkiprofile.
placement_réseauxchaîne de caractères Sélectionnez manuellement les réseaux et sous-réseaux utilisés pour fournir l'accessibilité aux serveurs du pool.Spécifiez le sous-réseau en utilisant la syntaxe suivante 10-1-1-0/24.Utilisez les routes statiques dans la configuration vrf lorsque les serveurs du pool ne sont pas directement connectés maisroutables depuis le moteur de service.
prst_hdr_namechaîne de caractères Nom de l'en-tête pour la persistance de l'en-tête personnalisé.Champ déprécié en 18.1.2.
request_queue_depthchaîne de caractères Nombre minimum de demandes à mettre en file d'attente lorsque le pool est plein.La valeur par défaut lorsqu'elle n'est pas spécifiée dans l'API ou le module est interprétée par Avi Controller comme 128.
request_queue_enabledbooléen
    Choix :

  • pas de
  • oui
Activer la file d'attente des demandes lorsque le pool est plein.La valeur par défaut lorsqu'elle n'est pas spécifiée dans l'API ou le module est interprétée par Avi Controller comme False.
rewrite_host_header_to_server_nameboolean
    Choix :

  • pas de
  • oui
Réécrire l'en-tête d'hôte entrant en nom de serveur du serveur vers lequel la demande est proxiée.L'activation de cette fonctionnalité réécrit l'en-tête d'hôte pour les demandes à tous les serveurs du pool.La valeur par défaut lorsqu'elle n'est pas spécifiée dans l'API ou le module est interprétée par Avi Controller comme False.
rewrite_host_header_to_snibooléen
    Choix :

  • pas de
  • oui
Si le nom du serveur sni est spécifié, réécrire l'en-tête d'hôte entrant vers le nom du serveur sni.La valeur par défaut lorsqu'elle n'est pas spécifiée dans l'API ou le module est interprétée par Avi Controller comme False.
server_auto_scalebooléen
    Choix :

  • pas de
  • oui
Server autoscale.N'est plus utilisé.Champ déprécié en 18.1.2.
serveur_countchaîne de caractères Champ déprécié en 18.2.1.
nom_serveurchaîne de caractères Nom d'hôte dns pleinement qualifié qui sera utilisé dans l'extension tls sni dans les connexions de serveur si sni est activé.Si aucune valeur n'est spécifiée, avi utilisera l'en-tête d'hôte entrant à la place.
server_reselectchaîne de caractères Configuration de reselection du serveur pour les requêtes http.
server_timeoutchaîne de caractères La valeur du délai d'attente du serveur spécifie le temps dans lequel une connexion au serveur doit être établie et un échange de demande-réponse se termine entre l'avi et le serveur.La valeur de 0 entraîne l'utilisation du délai d'attente par défaut de 60 minutes.Les valeurs autorisées sont 0-3600000.Champ introduit dans 18.1.5,18.2.1.La valeur par défaut lorsqu'elle n'est pas spécifiée dans l'API ou le module est interprétée par Avi Controller comme 0.
serveurschaîne de caractères Le pool dirige le trafic équilibré en charge vers cette liste de serveurs de destination.Les serveurs peuvent être configurés par adresse ip, nom, réseau ou via un groupe d'adresses ip.
service_metadatachaîne de caractères Métadonnées relatives au service fourni par ce pool.Dans les environnements openshift/kubernetes, les infos sur les métadonnées des apps sont stockées.Toute entrée de l'utilisateur dans ce champ sera écrasée par avi vantage.Champ introduit dans 17.2.14,18.1.5,18.2.1.
sni_enabledbooléen
    Choix :

  • pas de
  • oui
Activer le sni tls pour les connexions au serveur.Si elle est désactivée, avi n'enverra pas l'extension sni dans le cadre du handshake.La valeur par défaut lorsqu'elle n'est pas spécifiée dans l'API ou le module est interprétée par Avi Controller comme True.
ssl_key_and_certificate_refchaîne de caractères Les moteurs de service présenteront un certificat ssl du client au serveur.C'est une référence à un objet de type sslkeyandcertificate.
ssl_profile_refchaîne de caractères Lorsqu'il est activé, avi ré-encrypte le trafic vers les serveurs backend.Le profil ssl spécifique définit quels chiffrements et versions ssl seront supportés.C'est une référence à un objet de type sslprofile.
étatchaîne de caractères
    Choix :

  • absent
  • présent
L'état qui doit être appliqué sur l'entité.
locatairechaîne de caractères Par défaut :
"admin"
Nom du locataire utilisé pour tous les appels de l'API Avi et le contexte de l'objet.
tenant_refchaîne de caractères Il s'agit d'une référence à un objet de type tenant.
locataire_uuidchaîne de caractères Par défaut :
""
UUID du locataire utilisé pour tous les appels de l'API Avi et le contexte de l'objet.
urlchaîne de caractères URL du contrôleur Avi de l'objet.
use_service_portbooléen
    Choix :

  • pas de
  • oui
Ne pas traduire le port de destination du client lors de l'envoi de la connexion au serveur.Le port de service spécifié par le pool ou les serveurs sera toujours utilisé pour la surveillance de la santé.La valeur par défaut lorsqu'elle n'est pas spécifiée dans l'API ou le module est interprétée par Avi Controller comme False.
nom d'utilisateurchaîne de caractères Par défaut :
""
Nom d'utilisateur utilisé pour accéder au contrôleur Avi. La valeur par défaut est la variable d'environnement AVI_USERNAME.
uuidchaîne de caractères Uuid du pool.
vrf_refchaîne de caractères Contexte de routage virtuel auquel le pool est lié.Ceci est utilisé pour fournir l'isolation de l'ensemble des réseaux auxquels le pool est attaché.Le pool hérite du contexte de routage virtuel du service virtuel, et ce champ est utilisé uniquement en interne, et est défini par pb-transform.C'est une référence à un objet de type vrfcontext.

Notes

Note

Exemples

-name: Create a Pool with two servers and HTTP monitor
  community.network.avi_pool:controller: 10.10.1.20
    username: avi_user
    password: avi_password
    name: testpool1
    description: testpool1
    state: present
    health_monitor_refs:-'/api/healthmonitor?name=System-HTTP'servers:-ip:addr: 10.10.2.20
            type: V4
        -ip:addr: 10.10.2.21
            type: V4

-name: Patch pool with a single server using patch op and avi_credentials
  community.network.avi_pool:avi_api_update_method: patch
    avi_api_patch_op: delete
    avi_credentials:"{{avi_credentials}}"name: test-pool
    servers:-ip:addr: 10.90.64.13
        type:'V4'register: pool
  when:- state | default("present") == "present"

Valeurs de retour

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

Clé Renvoyé Description
objdictionnaire succès, modifié Objet Pool (api/pool)

Auteurs