mirror of https://github.com/ansible/ansible.git
Tim Rupp
6 years ago
committed by
GitHub
parent
92cf066514
commit
114d591f31
@ -0,0 +1,745 @@
|
||||
#!/usr/bin/python
|
||||
# -*- coding: utf-8 -*-
|
||||
#
|
||||
# Copyright: (c) 2018, F5 Networks Inc.
|
||||
# GNU General Public License v3.0 (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
|
||||
|
||||
from __future__ import absolute_import, division, print_function
|
||||
__metaclass__ = type
|
||||
|
||||
|
||||
ANSIBLE_METADATA = {'metadata_version': '1.1',
|
||||
'status': ['preview'],
|
||||
'supported_by': 'certified'}
|
||||
|
||||
DOCUMENTATION = r'''
|
||||
---
|
||||
module: bigip_ike_peer
|
||||
short_description: Manage IPSec IKE Peer configuration on BIG-IP
|
||||
description:
|
||||
- Manage IPSec IKE Peer configuration on BIG-IP.
|
||||
version_added: 2.8
|
||||
options:
|
||||
name:
|
||||
description:
|
||||
- Specifies the name of the IKE peer.
|
||||
required: True
|
||||
version:
|
||||
description:
|
||||
- Specifies which version of IKE is used.
|
||||
- If the system you are configuring is the IPsec initiator, and you select
|
||||
both versions, the system tries using IKEv2 for negotiation. If the remote
|
||||
peer does not support IKEv2, the IPsec tunnel fails. To use IKEv1 in this
|
||||
case, you must deselect Version 2 and try again.
|
||||
- If the system you are configuring is the IPsec responder, and you select
|
||||
both versions, the IPsec initiator system determines which IKE version to use.
|
||||
- When creating a new IKE peer, this value is required.
|
||||
choices:
|
||||
- v1
|
||||
- v2
|
||||
presented_id_type:
|
||||
description:
|
||||
- Specifies the identifier type that the local system uses to identify
|
||||
itself to the peer during IKE Phase 1 negotiations.
|
||||
choices:
|
||||
- address
|
||||
- asn1dn
|
||||
- fqdn
|
||||
- keyid-tag
|
||||
- user-fqdn
|
||||
- override
|
||||
presented_id_value:
|
||||
description:
|
||||
- This is a required value when C(version) includes (Cv2).
|
||||
- Specifies a value for the identity when using a C(presented_id_type) of
|
||||
C(override).
|
||||
verified_id_type:
|
||||
description:
|
||||
- Specifies the identifier type that the local system uses to identify
|
||||
the peer during IKE Phase 1 negotiation.
|
||||
- This is a required value when C(version) includes (Cv2).
|
||||
- When C(user-fqdn), value of C(verified_id_value) must be in the form of
|
||||
User @ DNS domain string.
|
||||
choices:
|
||||
- address
|
||||
- asn1dn
|
||||
- fqdn
|
||||
- keyid-tag
|
||||
- user-fqdn
|
||||
- override
|
||||
verified_id_value:
|
||||
description:
|
||||
- This is a required value when C(version) includes (Cv2).
|
||||
- Specifies a value for the identity when using a C(verified_id_type) of
|
||||
C(override).
|
||||
phase1_auth_method:
|
||||
description:
|
||||
- Specifies the authentication method for phase 1 negotiation.
|
||||
- When creating a new IKE peer, if this value is not specified, the default is
|
||||
C(rsa-signature).
|
||||
choices:
|
||||
- pre-shared-key
|
||||
- rsa-signature
|
||||
phase1_cert:
|
||||
description:
|
||||
- Specifies the digital certificate to use for the RSA signature.
|
||||
- When creating a new IKE peer, if this value is not specified, and
|
||||
C(phase1_auth_method) is C(rsa-signature), the default is C(default.crt).
|
||||
- This parameter is invalid when C(phase1_auth_method) is C(pre-shared-key).
|
||||
phase1_key:
|
||||
description:
|
||||
- Specifies the public key that the digital certificate contains.
|
||||
- When creating a new IKE peer, if this value is not specified, and
|
||||
C(phase1_auth_method) is C(rsa-signature), the default is C(default.key).
|
||||
- This parameter is invalid when C(phase1_auth_method) is C(pre-shared-key).
|
||||
phase1_verify_peer_cert:
|
||||
description:
|
||||
- In IKEv2, specifies whether the certificate sent by the IKE peer is verified
|
||||
using the Trusted Certificate Authorities, a CRL, and/or a peer certificate.
|
||||
- In IKEv1, specifies whether the identifier sent by the peer is verified with
|
||||
the credentials in the certificate, in the following manner - ASN1DN; specifies
|
||||
that the entire certificate subject name is compared with the identifier.
|
||||
Address, FQDN, or User FQDN; specifies that the certificate's subjectAltName is
|
||||
compared with the identifier. If the two do not match, the negotiation fails.
|
||||
- When creating a new IKE peer, if this value is not specified, and
|
||||
C(phase1_auth_method) is C(rsa-signature), the default is C(no).
|
||||
- This parameter is invalid when C(phase1_auth_method) is C(pre-shared-key).
|
||||
type: bool
|
||||
preshared_key:
|
||||
description:
|
||||
- Specifies a string that the IKE peers share for authenticating each other.
|
||||
- This parameter is only relevant when C(phase1_auth_method) is C(pre-shared-key).
|
||||
- This parameter is invalid when C(phase1_auth_method) is C(rsa-signature).
|
||||
remote_address:
|
||||
description:
|
||||
- Displays the IP address of the BIG-IP system that is remote to the system
|
||||
you are configuring.
|
||||
phase1_encryption_algorithm:
|
||||
description:
|
||||
- Specifies the algorithm to use for IKE encryption.
|
||||
- IKE C(version) C(v2) does not support C(blowfish), C(camellia), or C(cast128).
|
||||
choices:
|
||||
- 3des
|
||||
- des
|
||||
- blowfish
|
||||
- cast128
|
||||
- aes128
|
||||
- aes192
|
||||
- aes256
|
||||
- camellia
|
||||
phase1_hash_algorithm:
|
||||
description:
|
||||
- Specifies the algorithm to use for IKE authentication.
|
||||
choices:
|
||||
- sha1
|
||||
- md5
|
||||
- sha256
|
||||
- sha384
|
||||
- sha512
|
||||
phase1_perfect_forward_secrecy:
|
||||
description:
|
||||
- Specifies the Diffie-Hellman group to use for IKE Phase 1 and Phase 2 negotiations.
|
||||
choices:
|
||||
- ecp256
|
||||
- ecp384
|
||||
- ecp521
|
||||
- modp768
|
||||
- modp1024
|
||||
- modp1536
|
||||
- modp2048
|
||||
- modp3072
|
||||
- modp4096
|
||||
- modp6144
|
||||
- modp8192
|
||||
update_password:
|
||||
description:
|
||||
- C(always) will allow to update passwords if the user chooses to do so.
|
||||
C(on_create) will only set the password for newly created IKE peers.
|
||||
default: always
|
||||
choices:
|
||||
- always
|
||||
- on_create
|
||||
partition:
|
||||
description:
|
||||
- Device partition to manage resources on.
|
||||
default: Common
|
||||
state:
|
||||
description:
|
||||
- When C(present), ensures that the resource exists.
|
||||
- When C(absent), ensures the resource is removed.
|
||||
default: present
|
||||
choices:
|
||||
- present
|
||||
- absent
|
||||
extends_documentation_fragment: f5
|
||||
author:
|
||||
- Tim Rupp (@caphrim007)
|
||||
'''
|
||||
|
||||
EXAMPLES = r'''
|
||||
- name: Create a ...
|
||||
bigip_ike_peer:
|
||||
name: foo
|
||||
provider:
|
||||
password: secret
|
||||
server: lb.mydomain.com
|
||||
user: admin
|
||||
delegate_to: localhost
|
||||
'''
|
||||
|
||||
RETURN = r'''
|
||||
presented_id_type:
|
||||
description: The new Presented ID Type value of the resource.
|
||||
returned: changed
|
||||
type: string
|
||||
sample: address
|
||||
verified_id_type:
|
||||
description: The new Verified ID Type value of the resource.
|
||||
returned: changed
|
||||
type: string
|
||||
sample: address
|
||||
phase1_auth_method:
|
||||
description: The new IKE Phase 1 Credentials Authentication Method value of the resource.
|
||||
returned: changed
|
||||
type: string
|
||||
sample: rsa-signature
|
||||
remote_address:
|
||||
description: The new Remote Address value of the resource.
|
||||
returned: changed
|
||||
type: string
|
||||
sample: 1.2.2.1
|
||||
version:
|
||||
description: The new list of IKE versions.
|
||||
returned: changed
|
||||
type: list
|
||||
sample: ['v1', 'v2']
|
||||
phase1_encryption_algorithm:
|
||||
description: The new IKE Phase 1 Encryption Algorithm.
|
||||
returned: changed
|
||||
type: string
|
||||
sample: 3des
|
||||
phase1_hash_algorithm:
|
||||
description: The new IKE Phase 1 Authentication Algorithm.
|
||||
returned: changed
|
||||
type: string
|
||||
sample: sha256
|
||||
phase1_perfect_forward_secrecy:
|
||||
description: The new IKE Phase 1 Perfect Forward Secrecy.
|
||||
returned: changed
|
||||
type: string
|
||||
sample: modp1024
|
||||
phase1_cert:
|
||||
description: The new IKE Phase 1 Certificate Credentials.
|
||||
returned: changed
|
||||
type: string
|
||||
sample: /Common/cert1.crt
|
||||
phase1_key:
|
||||
description: The new IKE Phase 1 Key Credentials.
|
||||
returned: changed
|
||||
type: string
|
||||
sample: /Common/cert1.key
|
||||
phase1_verify_peer_cert:
|
||||
description: The new IKE Phase 1 Key Verify Peer Certificate setting.
|
||||
returned: changed
|
||||
type: bool
|
||||
sample: yes
|
||||
verified_id_value:
|
||||
description: The new Verified ID Value setting for the Verified ID Type.
|
||||
returned: changed
|
||||
type: string
|
||||
sample: 1.2.3.1
|
||||
presented_id_value:
|
||||
description: The new Presented ID Value setting for the Presented ID Type.
|
||||
returned: changed
|
||||
type: string
|
||||
sample: 1.2.3.1
|
||||
'''
|
||||
|
||||
from ansible.module_utils.basic import AnsibleModule
|
||||
from ansible.module_utils.basic import env_fallback
|
||||
|
||||
try:
|
||||
from library.module_utils.network.f5.bigip import F5RestClient
|
||||
from library.module_utils.network.f5.common import F5ModuleError
|
||||
from library.module_utils.network.f5.common import AnsibleF5Parameters
|
||||
from library.module_utils.network.f5.common import cleanup_tokens
|
||||
from library.module_utils.network.f5.common import fq_name
|
||||
from library.module_utils.network.f5.common import f5_argument_spec
|
||||
from library.module_utils.network.f5.common import exit_json
|
||||
from library.module_utils.network.f5.common import fail_json
|
||||
from library.module_utils.network.f5.common import transform_name
|
||||
from library.module_utils.network.f5.common import flatten_boolean
|
||||
except ImportError:
|
||||
from ansible.module_utils.network.f5.bigip import F5RestClient
|
||||
from ansible.module_utils.network.f5.common import F5ModuleError
|
||||
from ansible.module_utils.network.f5.common import AnsibleF5Parameters
|
||||
from ansible.module_utils.network.f5.common import cleanup_tokens
|
||||
from ansible.module_utils.network.f5.common import fq_name
|
||||
from ansible.module_utils.network.f5.common import f5_argument_spec
|
||||
from ansible.module_utils.network.f5.common import exit_json
|
||||
from ansible.module_utils.network.f5.common import fail_json
|
||||
from ansible.module_utils.network.f5.common import transform_name
|
||||
from ansible.module_utils.network.f5.common import flatten_boolean
|
||||
|
||||
|
||||
class Parameters(AnsibleF5Parameters):
|
||||
api_map = {
|
||||
'myIdType': 'presented_id_type',
|
||||
'peersIdType': 'verified_id_type',
|
||||
'phase1AuthMethod': 'phase1_auth_method',
|
||||
'presharedKeyEncrypted': 'preshared_key',
|
||||
'remoteAddress': 'remote_address',
|
||||
'version': 'version',
|
||||
'phase1EncryptAlgorithm': 'phase1_encryption_algorithm',
|
||||
'phase1HashAlgorithm': 'phase1_hash_algorithm',
|
||||
'phase1PerfectForwardSecrecy': 'phase1_perfect_forward_secrecy',
|
||||
'myCertFile': 'phase1_cert',
|
||||
'myCertKeyFile': 'phase1_key',
|
||||
'verifyCert': 'phase1_verify_peer_cert',
|
||||
'peersIdValue': 'verified_id_value',
|
||||
'myIdValue': 'presented_id_value',
|
||||
}
|
||||
|
||||
api_attributes = [
|
||||
'myIdType',
|
||||
'peersIdType',
|
||||
'phase1AuthMethod',
|
||||
'presharedKeyEncrypted',
|
||||
'remoteAddress',
|
||||
'version',
|
||||
'phase1EncryptAlgorithm',
|
||||
'phase1HashAlgorithm',
|
||||
'phase1PerfectForwardSecrecy',
|
||||
'myCertFile',
|
||||
'myCertKeyFile',
|
||||
'verifyCert',
|
||||
'peersIdValue',
|
||||
'myIdValue',
|
||||
]
|
||||
|
||||
returnables = [
|
||||
'presented_id_type',
|
||||
'verified_id_type',
|
||||
'phase1_auth_method',
|
||||
'preshared_key',
|
||||
'remote_address',
|
||||
'version',
|
||||
'phase1_encryption_algorithm',
|
||||
'phase1_hash_algorithm',
|
||||
'phase1_perfect_forward_secrecy',
|
||||
'phase1_cert',
|
||||
'phase1_key',
|
||||
'phase1_verify_peer_cert',
|
||||
'verified_id_value',
|
||||
'presented_id_value',
|
||||
]
|
||||
|
||||
updatables = [
|
||||
'presented_id_type',
|
||||
'verified_id_type',
|
||||
'phase1_auth_method',
|
||||
'preshared_key',
|
||||
'remote_address',
|
||||
'version',
|
||||
'phase1_encryption_algorithm',
|
||||
'phase1_hash_algorithm',
|
||||
'phase1_perfect_forward_secrecy',
|
||||
'phase1_cert',
|
||||
'phase1_key',
|
||||
'phase1_verify_peer_cert',
|
||||
'verified_id_value',
|
||||
'presented_id_value',
|
||||
]
|
||||
|
||||
@property
|
||||
def phase1_verify_peer_cert(self):
|
||||
return flatten_boolean(self._values['phase1_verify_peer_cert'])
|
||||
|
||||
|
||||
class ApiParameters(Parameters):
|
||||
pass
|
||||
|
||||
|
||||
class ModuleParameters(Parameters):
|
||||
@property
|
||||
def phase1_cert(self):
|
||||
if self._values['phase1_cert'] is None:
|
||||
return None
|
||||
if self._values['phase1_cert'] in ['', 'none']:
|
||||
return ''
|
||||
return fq_name(self.partition, self._values['phase1_cert'])
|
||||
|
||||
@property
|
||||
def phase1_key(self):
|
||||
if self._values['phase1_key'] is None:
|
||||
return None
|
||||
if self._values['phase1_key'] in ['', 'none']:
|
||||
return ''
|
||||
return fq_name(self.partition, self._values['phase1_key'])
|
||||
|
||||
|
||||
class Changes(Parameters):
|
||||
def to_return(self):
|
||||
result = {}
|
||||
try:
|
||||
for returnable in self.returnables:
|
||||
result[returnable] = getattr(self, returnable)
|
||||
result = self._filter_params(result)
|
||||
except Exception:
|
||||
pass
|
||||
return result
|
||||
|
||||
|
||||
class UsableChanges(Changes):
|
||||
@property
|
||||
def phase1_verify_peer_cert(self):
|
||||
if self._values['phase1_verify_peer_cert'] is None:
|
||||
return None
|
||||
elif self._values['phase1_verify_peer_cert'] == 'yes':
|
||||
return 'true'
|
||||
else:
|
||||
return 'false'
|
||||
|
||||
|
||||
class ReportableChanges(Changes):
|
||||
@property
|
||||
def phase1_verify_peer_cert(self):
|
||||
return flatten_boolean(self._values['phase1_verify_peer_cert'])
|
||||
|
||||
@property
|
||||
def preshared_key(self):
|
||||
return None
|
||||
|
||||
|
||||
class Difference(object):
|
||||
def __init__(self, want, have=None):
|
||||
self.want = want
|
||||
self.have = have
|
||||
|
||||
def compare(self, param):
|
||||
try:
|
||||
result = getattr(self, param)
|
||||
return result
|
||||
except AttributeError:
|
||||
return self.__default(param)
|
||||
|
||||
def __default(self, param):
|
||||
attr1 = getattr(self.want, param)
|
||||
try:
|
||||
attr2 = getattr(self.have, param)
|
||||
if attr1 != attr2:
|
||||
return attr1
|
||||
except AttributeError:
|
||||
return attr1
|
||||
|
||||
|
||||
class ModuleManager(object):
|
||||
def __init__(self, *args, **kwargs):
|
||||
self.module = kwargs.get('module', None)
|
||||
self.client = kwargs.get('client', None)
|
||||
self.want = ModuleParameters(params=self.module.params)
|
||||
self.have = ApiParameters()
|
||||
self.changes = UsableChanges()
|
||||
|
||||
def _set_changed_options(self):
|
||||
changed = {}
|
||||
for key in Parameters.returnables:
|
||||
if getattr(self.want, key) is not None:
|
||||
changed[key] = getattr(self.want, key)
|
||||
if changed:
|
||||
self.changes = UsableChanges(params=changed)
|
||||
|
||||
def _update_changed_options(self):
|
||||
diff = Difference(self.want, self.have)
|
||||
updatables = Parameters.updatables
|
||||
changed = dict()
|
||||
for k in updatables:
|
||||
change = diff.compare(k)
|
||||
if change is None:
|
||||
continue
|
||||
else:
|
||||
if isinstance(change, dict):
|
||||
changed.update(change)
|
||||
else:
|
||||
changed[k] = change
|
||||
if changed:
|
||||
self.changes = UsableChanges(params=changed)
|
||||
return True
|
||||
return False
|
||||
|
||||
def should_update(self):
|
||||
result = self._update_changed_options()
|
||||
if result:
|
||||
return True
|
||||
return False
|
||||
|
||||
def exec_module(self):
|
||||
changed = False
|
||||
result = dict()
|
||||
state = self.want.state
|
||||
|
||||
if state == "present":
|
||||
changed = self.present()
|
||||
elif state == "absent":
|
||||
changed = self.absent()
|
||||
|
||||
reportable = ReportableChanges(params=self.changes.to_return())
|
||||
changes = reportable.to_return()
|
||||
result.update(**changes)
|
||||
result.update(dict(changed=changed))
|
||||
self._announce_deprecations(result)
|
||||
return result
|
||||
|
||||
def _announce_deprecations(self, result):
|
||||
warnings = result.pop('__warnings', [])
|
||||
for warning in warnings:
|
||||
self.client.module.deprecate(
|
||||
msg=warning['msg'],
|
||||
version=warning['version']
|
||||
)
|
||||
|
||||
def present(self):
|
||||
if self.exists():
|
||||
return self.update()
|
||||
else:
|
||||
return self.create()
|
||||
|
||||
def exists(self):
|
||||
uri = "https://{0}:{1}/mgmt/tm/net/ipsec/ike-peer/{2}".format(
|
||||
self.client.provider['server'],
|
||||
self.client.provider['server_port'],
|
||||
transform_name(self.want.partition, self.want.name)
|
||||
)
|
||||
resp = self.client.api.get(uri)
|
||||
try:
|
||||
response = resp.json()
|
||||
except ValueError:
|
||||
return False
|
||||
if resp.status == 404 or 'code' in response and response['code'] == 404:
|
||||
return False
|
||||
return True
|
||||
|
||||
def update(self):
|
||||
self.have = self.read_current_from_device()
|
||||
|
||||
if self.changes.version is not None and len(self.changes.version) == 0:
|
||||
raise F5ModuleError(
|
||||
"At least one version value must be specified."
|
||||
)
|
||||
|
||||
if self.changes.phase1_auth_method == 'pre-shared-key':
|
||||
if self.changes.preshared_key is None and self.have.preshared_key is None:
|
||||
raise F5ModuleError(
|
||||
"A 'preshared_key' must be specified when changing 'phase1_auth_method' "
|
||||
"to 'pre-shared-key'."
|
||||
)
|
||||
|
||||
if self.want.update_password == 'always':
|
||||
self.want.update({'preshared_key': self.want.preshared_key})
|
||||
else:
|
||||
if self.want.preshared_key:
|
||||
del self.want._values['preshared_key']
|
||||
|
||||
if not self.should_update():
|
||||
return False
|
||||
if self.module.check_mode:
|
||||
return True
|
||||
self.update_on_device()
|
||||
return True
|
||||
|
||||
def remove(self):
|
||||
if self.module.check_mode:
|
||||
return True
|
||||
self.remove_from_device()
|
||||
if self.exists():
|
||||
raise F5ModuleError("Failed to delete the resource.")
|
||||
return True
|
||||
|
||||
def create(self):
|
||||
self._set_changed_options()
|
||||
if self.changes.version is None:
|
||||
raise F5ModuleError(
|
||||
"The 'version' parameter is required when creating a new IKE peer."
|
||||
)
|
||||
if self.changes.phase1_auth_method is None:
|
||||
self.changes.update({'phase1_auth_method': 'rsa-signature'})
|
||||
if self.changes.phase1_cert is None:
|
||||
self.changes.update({'phase1_cert': 'default.crt'})
|
||||
if self.changes.phase1_key is None:
|
||||
self.changes.update({'phase1_key': 'default.key'})
|
||||
|
||||
if self.module.check_mode:
|
||||
return True
|
||||
self.create_on_device()
|
||||
return True
|
||||
|
||||
def create_on_device(self):
|
||||
params = self.changes.api_params()
|
||||
params['name'] = self.want.name
|
||||
params['partition'] = self.want.partition
|
||||
uri = "https://{0}:{1}/mgmt/tm/net/ipsec/ike-peer/".format(
|
||||
self.client.provider['server'],
|
||||
self.client.provider['server_port']
|
||||
)
|
||||
resp = self.client.api.post(uri, json=params)
|
||||
try:
|
||||
response = resp.json()
|
||||
except ValueError as ex:
|
||||
raise F5ModuleError(str(ex))
|
||||
|
||||
if 'code' in response and response['code'] in [400, 403]:
|
||||
if 'message' in response:
|
||||
raise F5ModuleError(response['message'])
|
||||
else:
|
||||
raise F5ModuleError(resp.content)
|
||||
|
||||
def update_on_device(self):
|
||||
params = self.changes.api_params()
|
||||
uri = "https://{0}:{1}/mgmt/tm/net/ipsec/ike-peer/{2}".format(
|
||||
self.client.provider['server'],
|
||||
self.client.provider['server_port'],
|
||||
transform_name(self.want.partition, self.want.name)
|
||||
)
|
||||
resp = self.client.api.patch(uri, json=params)
|
||||
try:
|
||||
response = resp.json()
|
||||
except ValueError as ex:
|
||||
raise F5ModuleError(str(ex))
|
||||
|
||||
if 'code' in response and response['code'] == 400:
|
||||
if 'message' in response:
|
||||
raise F5ModuleError(response['message'])
|
||||
else:
|
||||
raise F5ModuleError(resp.content)
|
||||
|
||||
def absent(self):
|
||||
if self.exists():
|
||||
return self.remove()
|
||||
return False
|
||||
|
||||
def remove_from_device(self):
|
||||
uri = "https://{0}:{1}/mgmt/tm/net/ipsec/ike-peer/{2}".format(
|
||||
self.client.provider['server'],
|
||||
self.client.provider['server_port'],
|
||||
transform_name(self.want.partition, self.want.name)
|
||||
)
|
||||
resp = self.client.api.delete(uri)
|
||||
if resp.status == 200:
|
||||
return True
|
||||
|
||||
def read_current_from_device(self):
|
||||
uri = "https://{0}:{1}/mgmt/tm/net/ipsec/ike-peer/{2}".format(
|
||||
self.client.provider['server'],
|
||||
self.client.provider['server_port'],
|
||||
transform_name(self.want.partition, self.want.name)
|
||||
)
|
||||
resp = self.client.api.get(uri)
|
||||
try:
|
||||
response = resp.json()
|
||||
except ValueError as ex:
|
||||
raise F5ModuleError(str(ex))
|
||||
|
||||
if 'code' in response and response['code'] == 400:
|
||||
if 'message' in response:
|
||||
raise F5ModuleError(response['message'])
|
||||
else:
|
||||
raise F5ModuleError(resp.content)
|
||||
return ApiParameters(params=response)
|
||||
|
||||
|
||||
class ArgumentSpec(object):
|
||||
def __init__(self):
|
||||
self.supports_check_mode = True
|
||||
argument_spec = dict(
|
||||
name=dict(required=True),
|
||||
presented_id_type=dict(
|
||||
choices=['address', 'asn1dn', 'fqdn', 'keyid-tag', 'user-fqdn', 'override']
|
||||
),
|
||||
presented_id_value=dict(),
|
||||
verified_id_type=dict(
|
||||
choices=['address', 'asn1dn', 'fqdn', 'keyid-tag', 'user-fqdn', 'override']
|
||||
),
|
||||
verified_id_value=dict(),
|
||||
phase1_auth_method=dict(
|
||||
choices=[
|
||||
'pre-shared-key', 'rsa-signature'
|
||||
]
|
||||
),
|
||||
preshared_key=dict(no_log=True),
|
||||
remote_address=dict(),
|
||||
version=dict(
|
||||
type='list',
|
||||
choices=['v1', 'v2']
|
||||
),
|
||||
phase1_encryption_algorithm=dict(
|
||||
choices=[
|
||||
'3des', 'des', 'blowfish', 'cast128', 'aes128', 'aes192',
|
||||
'aes256', 'camellia'
|
||||
]
|
||||
),
|
||||
phase1_hash_algorithm=dict(
|
||||
choices=[
|
||||
'sha1', 'md5', 'sha256', 'sha384', 'sha512'
|
||||
]
|
||||
),
|
||||
phase1_perfect_forward_secrecy=dict(
|
||||
choices=[
|
||||
'ecp256', 'ecp384', 'ecp521', 'modp768', 'modp1024', 'modp1536',
|
||||
'modp2048', 'modp3072', 'modp4096', 'modp6144', 'modp8192'
|
||||
]
|
||||
),
|
||||
phase1_cert=dict(),
|
||||
phase1_key=dict(),
|
||||
phase1_verify_peer_cert=dict(type='bool'),
|
||||
update_password=dict(
|
||||
default='always',
|
||||
choices=['always', 'on_create']
|
||||
),
|
||||
state=dict(default='present', choices=['absent', 'present']),
|
||||
partition=dict(
|
||||
default='Common',
|
||||
fallback=(env_fallback, ['F5_PARTITION'])
|
||||
)
|
||||
)
|
||||
self.argument_spec = {}
|
||||
self.argument_spec.update(f5_argument_spec)
|
||||
self.argument_spec.update(argument_spec)
|
||||
self.required_if = [
|
||||
['presented_id_type', 'fqdn', ['presented_id_value']],
|
||||
['presented_id_type', 'keyid-tag', ['presented_id_value']],
|
||||
['presented_id_type', 'user-fqdn', ['presented_id_value']],
|
||||
['presented_id_type', 'override', ['presented_id_value']],
|
||||
|
||||
['verified_id_type', 'fqdn', ['verified_id_value']],
|
||||
['verified_id_type', 'keyid-tag', ['verified_id_value']],
|
||||
['verified_id_type', 'user-fqdn', ['verified_id_value']],
|
||||
['verified_id_type', 'override', ['verified_id_value']],
|
||||
]
|
||||
self.required_together = [
|
||||
['phase1_cert', 'phase1_key']
|
||||
]
|
||||
|
||||
|
||||
def main():
|
||||
spec = ArgumentSpec()
|
||||
|
||||
module = AnsibleModule(
|
||||
argument_spec=spec.argument_spec,
|
||||
supports_check_mode=spec.supports_check_mode,
|
||||
required_if=spec.required_if,
|
||||
required_together=spec.required_together,
|
||||
)
|
||||
|
||||
try:
|
||||
client = F5RestClient(**module.params)
|
||||
mm = ModuleManager(module=module, client=client)
|
||||
results = mm.exec_module()
|
||||
cleanup_tokens(client)
|
||||
exit_json(module, results, client)
|
||||
except F5ModuleError as ex:
|
||||
cleanup_tokens(client)
|
||||
fail_json(module, ex, client)
|
||||
|
||||
|
||||
if __name__ == '__main__':
|
||||
main()
|
||||
@ -0,0 +1,111 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
#
|
||||
# Copyright: (c) 2018, F5 Networks Inc.
|
||||
# GNU General Public License v3.0 (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
|
||||
|
||||
from __future__ import (absolute_import, division, print_function)
|
||||
__metaclass__ = type
|
||||
|
||||
import os
|
||||
import json
|
||||
import sys
|
||||
|
||||
from nose.plugins.skip import SkipTest
|
||||
if sys.version_info < (2, 7):
|
||||
raise SkipTest("F5 Ansible modules require Python >= 2.7")
|
||||
|
||||
from ansible.module_utils.basic import AnsibleModule
|
||||
|
||||
try:
|
||||
from library.modules.bigip_ike_peer import ApiParameters
|
||||
from library.modules.bigip_ike_peer import ModuleParameters
|
||||
from library.modules.bigip_ike_peer import ModuleManager
|
||||
from library.modules.bigip_ike_peer import ArgumentSpec
|
||||
|
||||
# In Ansible 2.8, Ansible changed import paths.
|
||||
from test.units.compat import unittest
|
||||
from test.units.compat.mock import Mock
|
||||
from test.units.compat.mock import patch
|
||||
|
||||
from test.units.modules.utils import set_module_args
|
||||
except ImportError:
|
||||
try:
|
||||
from ansible.modules.network.f5.bigip_ike_peer import ApiParameters
|
||||
from ansible.modules.network.f5.bigip_ike_peer import ModuleParameters
|
||||
from ansible.modules.network.f5.bigip_ike_peer import ModuleManager
|
||||
from ansible.modules.network.f5.bigip_ike_peer import ArgumentSpec
|
||||
|
||||
# Ansible 2.8 imports
|
||||
from units.compat import unittest
|
||||
from units.compat.mock import Mock
|
||||
from units.compat.mock import patch
|
||||
|
||||
from units.modules.utils import set_module_args
|
||||
except ImportError:
|
||||
raise SkipTest("F5 Ansible modules require the f5-sdk Python library")
|
||||
|
||||
fixture_path = os.path.join(os.path.dirname(__file__), 'fixtures')
|
||||
fixture_data = {}
|
||||
|
||||
|
||||
def load_fixture(name):
|
||||
path = os.path.join(fixture_path, name)
|
||||
|
||||
if path in fixture_data:
|
||||
return fixture_data[path]
|
||||
|
||||
with open(path) as f:
|
||||
data = f.read()
|
||||
|
||||
try:
|
||||
data = json.loads(data)
|
||||
except Exception:
|
||||
pass
|
||||
|
||||
fixture_data[path] = data
|
||||
return data
|
||||
|
||||
|
||||
class TestParameters(unittest.TestCase):
|
||||
def test_module_parameters(self):
|
||||
args = dict(
|
||||
name='ike1',
|
||||
)
|
||||
p = ModuleParameters(params=args)
|
||||
assert p.name == 'ike1'
|
||||
|
||||
def test_api_parameters(self):
|
||||
args = dict(
|
||||
name='ike1',
|
||||
)
|
||||
p = ApiParameters(params=args)
|
||||
assert p.name == 'ike1'
|
||||
|
||||
|
||||
class TestUntypedManager(unittest.TestCase):
|
||||
|
||||
def setUp(self):
|
||||
self.spec = ArgumentSpec()
|
||||
|
||||
def test_create(self, *args):
|
||||
set_module_args(dict(
|
||||
name='ike1',
|
||||
version=['v1'],
|
||||
password='password',
|
||||
server='localhost',
|
||||
user='admin'
|
||||
))
|
||||
|
||||
module = AnsibleModule(
|
||||
argument_spec=self.spec.argument_spec,
|
||||
supports_check_mode=self.spec.supports_check_mode
|
||||
)
|
||||
|
||||
# Override methods to force specific logic in the module to happen
|
||||
mm = ModuleManager(module=module)
|
||||
mm.create_on_device = Mock(return_value=True)
|
||||
mm.exists = Mock(return_value=False)
|
||||
|
||||
results = mm.exec_module()
|
||||
|
||||
assert results['changed'] is True
|
||||
Loading…
Reference in New Issue