New in version 2.7.
The below requirements are needed on the host that executes this module.
Parameter | Choices/Defaults | Comments | |
---|---|---|---|
description | Description of the profile. | ||
dns_resolver | Specifies the name of a configured DNS resolver, this option is mandatory when proxy_type is set to explicit .Format of the name can be either be prepended by partition ( /Common/foo ), or specified just as an object name (foo ).To remove the entry a value of none or '' can be set, however the profile proxy_type must not be set as explicit . | ||
encrypt_cookie_secret | Passphrase for cookie encryption. When creating a new profile, if this parameter is not specified, the default is provided by the parent profile. | ||
encrypt_cookies list | Cookie names for the system to encrypt. To remove the entry completely a value of none or '' should be set.When creating a new profile, if this parameter is not specified, the default is provided by the parent profile. | ||
insert_xforwarded_for bool |
| When specified system inserts an X-Forwarded-For header in an HTTP request with the client IP address, to use with connection pooling. When creating a new profile, if this parameter is not specified, the default is provided by the parent profile. | |
name required | Specifies the name of the profile. | ||
parent | Default: /Common/http | Specifies the profile from which this profile inherits settings. When creating a new profile, if this parameter is not specified, the default is the system-supplied http profile. | |
partition | Default: Common | Device partition to manage resources on. | |
password required | The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable F5_PASSWORD .aliases: pass, pwd | ||
provider (added in 2.5) | Default: None | A dict object containing connection details. | |
ssh_keyfile | Specifies the SSH keyfile to use to authenticate the connection to the remote device. This argument is only used for cli transports. You may omit this option by setting the environment variable ANSIBLE_NET_SSH_KEYFILE . | ||
timeout | Default: 10 | Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. | |
server required | The BIG-IP host. You may omit this option by setting the environment variable F5_SERVER . | ||
user required | The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable F5_USER . | ||
server_port | Default: 443 | The BIG-IP server port. You may omit this option by setting the environment variable F5_SERVER_PORT . | |
password required | The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable F5_PASSWORD .aliases: pass, pwd | ||
validate_certs bool |
| If no , SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates.You may omit this option by setting the environment variable F5_VALIDATE_CERTS . | |
transport required |
| Configures the transport connection to use when connecting to the remote device. | |
proxy_type |
| Specifies the proxy mode for the profile. When creating a new profile, if this parameter is not specified, the default is provided by the parent profile. | |
redirect_rewrite |
| Specifies whether the system rewrites the URIs that are part of HTTP redirect (3XX) responses. When set to none the system will not rewrite the URI in any HTTP redirect responses.When set to all the system rewrites the URI in all HTTP redirect responses.When set to matching the system rewrites the URI in any HTTP redirect responses that match the request URI.When set to nodes if the URI contains a node IP address instead of a host name, the system changes it to the virtual server address.When creating a new profile, if this parameter is not specified, the default is provided by the parent profile. | |
server required | The BIG-IP host. You may omit this option by setting the environment variable F5_SERVER . | ||
server_port (added in 2.2) | Default: 443 | The BIG-IP server port. You may omit this option by setting the environment variable F5_SERVER_PORT . | |
state |
| When present , ensures that the profile exists.When absent , ensures the profile is removed. | |
update_password |
| always will update passwords if the encrypt_cookie_secret is specified.on_create will only set the password for newly created profiles. | |
user required | The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable F5_USER . | ||
validate_certs bool (added in 2.0) |
| If no , SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates.You may omit this option by setting the environment variable F5_VALIDATE_CERTS . |
Note
pip install f5-sdk
.- name: Create HTTP profile bigip_profile_http: name: my_profile password: secret server: lb.mydomain.com insert_xforwarded_for: yes redirect_rewrite: all state: present user: admin delegate_to: localhost - name: Remove HTTP profile bigip_profile_http: name: my_profile state: absent server: lb.mydomain.com user: admin password: secret delegate_to: localhost - name: Add HTTP profile for transparent proxy bigip_profile_http: name: my_profile server: lb.mydomain.com user: admin proxy_type: transparent password: secret delegate_to: localhost
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
description string | changed | Description of the profile. Sample: My profile |
dns_resolver string | changed | Configured dns resolver. Sample: /Common/FooBar |
encrypt_cookies list | changed | Cookie names to encrypt. Sample: ['MyCookie1', 'MyCookie2'] |
insert_xforwarded_for bool | changed | Insert X-Forwarded-For-Header. Sample: True |
proxy_type string | changed | Specify proxy mode of the profile. Sample: explicit |
redirect_rewrite string | changed | Rewrite URI that are part of 3xx responses. Sample: all |
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
This module is flagged as community which means that it is maintained by the Ansible Community. See Module Maintenance & Support for more info.
For a list of other modules that are also maintained by the Ansible Community, see here.
Hint
If you notice any issues in this documentation you can edit this document to improve it.
© 2012–2018 Michael DeHaan
© 2018 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.7/modules/bigip_profile_http_module.html