def main():
argument_spec = mso_argument_spec()
argument_spec.update(
schema=dict(type='str', required=True),
template=dict(type='str', required=True),
contract=dict(type='str', required=True),
contract_display_name=dict(type='str'),
contract_scope=dict(
type='str',
choices=['application-profile', 'global', 'tenant', 'vrf']),
contract_filter_type=dict(type='str',
default='both-way',
choices=['both-way', 'one-way']),
filter=dict(type='str', aliases=[
'name'
]), # This parameter is not required for querying all objects
filter_directives=dict(type='list', choices=['log', 'none']),
filter_template=dict(type='str'),
filter_schema=dict(type='str'),
filter_type=dict(type='str',
default='both-way',
choices=list(FILTER_KEYS),
aliases=['type']),
state=dict(type='str',
default='present',
choices=['absent', 'present', 'query']),
)
module = AnsibleModule(
argument_spec=argument_spec,
supports_check_mode=True,
required_if=[
['state', 'absent', ['filter']],
['state', 'present', ['filter']],
],
)
schema = module.params.get('schema')
template = module.params.get('template')
contract = module.params.get('contract')
contract_display_name = module.params.get('contract_display_name')
contract_filter_type = module.params.get('contract_filter_type')
contract_scope = module.params.get('contract_scope')
filter_name = module.params.get('filter')
filter_directives = module.params.get('filter_directives')
filter_template = module.params.get('filter_template')
filter_schema = module.params.get('filter_schema')
filter_type = module.params.get('filter_type')
state = module.params.get('state')
mso = MSOModule(module)
contract_ftype = 'bothWay' if contract_filter_type == 'both-way' else 'oneWay'
if contract_filter_type == 'both-way' and filter_type != 'both-way':
mso.fail_json(
msg="You are adding 'one-way' filters to a 'both-way' contract")
elif contract_filter_type != 'both-way' and filter_type == 'both-way':
mso.fail_json(
msg="You are adding 'both-way' filters to a 'one-way' contract")
if filter_template is None:
filter_template = template
if filter_schema is None:
filter_schema = schema
filter_key = FILTER_KEYS.get(filter_type)
# Get schema object
schema_obj = mso.get_obj('schemas', displayName=schema)
if schema_obj:
schema_id = schema_obj.get('id')
else:
mso.fail_json(
msg="Provided schema '{0}' does not exist".format(schema))
schema_path = 'schemas/{id}'.format(**schema_obj)
# Get template
templates = [t.get('name') for t in schema_obj.get('templates')]
if template not in templates:
mso.fail_json(
msg="Provided template '{0}' does not exist. Existing templates: {1}"
.format(template, ', '.join(templates)))
template_idx = templates.index(template)
filter_schema_id = mso.lookup_schema(filter_schema)
# Get contracts
mso.existing = {}
contract_idx = None
filter_idx = None
contracts = [
c.get('name')
for c in schema_obj.get('templates')[template_idx]['contracts']
]
if contract in contracts:
contract_idx = contracts.index(contract)
filters = [
f.get('filterRef') for f in schema_obj.get('templates')
[template_idx]['contracts'][contract_idx][filter_key]
]
filter_ref = mso.filter_ref(schema_id=filter_schema_id,
template=filter_template,
filter=filter_name)
if filter_ref in filters:
filter_idx = filters.index(filter_ref)
filter_path = '/templates/{0}/contracts/{1}/{2}/{3}'.format(
template, contract, filter_key, filter_name)
mso.existing = schema_obj.get('templates')[template_idx][
'contracts'][contract_idx][filter_key][filter_idx]
if state == 'query':
if contract_idx is None:
mso.fail_json(
msg=
"Provided contract '{0}' does not exist. Existing contracts: {1}"
.format(contract, ', '.join(contracts)))
if filter_name is None:
mso.existing = schema_obj.get('templates')[template_idx][
'contracts'][contract_idx][filter_key]
elif not mso.existing:
mso.fail_json(msg="FilterRef '{filter_ref}' not found".format(
filter_ref=filter_ref))
mso.exit_json()
ops = []
contract_path = '/templates/{0}/contracts/{1}'.format(template, contract)
filters_path = '/templates/{0}/contracts/{1}/{2}'.format(
template, contract, filter_key)
mso.previous = mso.existing
if state == 'absent':
mso.proposed = mso.sent = {}
if contract_idx is None:
# There was no contract to begin with
pass
elif filter_idx is None:
# There was no filter to begin with
pass
elif len(filters) == 1:
# There is only one filter, remove contract
mso.existing = {}
ops.append(dict(op='remove', path=contract_path))
else:
# Remove filter
mso.existing = {}
ops.append(dict(op='remove', path=filter_path))
elif state == 'present':
if filter_directives is None:
filter_directives = ['none']
payload = dict(
filterRef=dict(
filterName=filter_name,
templateName=filter_template,
schemaId=filter_schema_id,
),
directives=filter_directives,
)
mso.sanitize(payload, collate=True)
mso.existing = mso.sent
if contract_scope is None or contract_scope == 'vrf':
contract_scope = 'context'
if contract_idx is None:
# Contract does not exist, so we have to create it
if contract_display_name is None:
contract_display_name = contract
payload = {
'name': contract,
'displayName': contract_display_name,
'filterType': contract_ftype,
'scope': contract_scope,
}
ops.append(
dict(op='add',
path='/templates/{0}/contracts/-'.format(template),
value=payload))
else:
# Contract exists, but may require an update
if contract_display_name is not None:
ops.append(
dict(op='replace',
path=contract_path + '/displayName',
value=contract_display_name))
ops.append(
dict(op='replace',
path=contract_path + '/filterType',
value=contract_ftype))
ops.append(
dict(op='replace',
path=contract_path + '/scope',
value=contract_scope))
if filter_idx is None:
# Filter does not exist, so we have to add it
ops.append(dict(op='add', path=filters_path + '/-',
value=mso.sent))
else:
# Filter exists, we have to update it
ops.append(dict(op='replace', path=filter_path, value=mso.sent))
if 'filterRef' in mso.previous:
mso.previous['filterRef'] = mso.dict_from_ref(
mso.previous['filterRef'])
if not module.check_mode:
mso.request(schema_path, method='PATCH', data=ops)
mso.exit_json()
def main():
argument_spec = mso_argument_spec()
argument_spec.update(
schema=dict(type='str', required=True),
template=dict(type='str', required=True),
contract=dict(type='str', required=True),
description=dict(type='str'),
contract_display_name=dict(type='str'),
contract_scope=dict(
type='str',
choices=['application-profile', 'global', 'tenant', 'vrf']),
contract_filter_type=dict(type='str',
default='both-way',
choices=['both-way', 'one-way']),
filter=dict(type='str', aliases=[
'name'
]), # This parameter is not required for querying all objects
filter_directives=dict(type='list',
elements='str',
choices=['log', 'none', 'policy_compression']),
filter_template=dict(type='str'),
filter_schema=dict(type='str'),
filter_type=dict(type='str',
default='both-way',
choices=list(FILTER_KEYS),
aliases=['type']),
qos_level=dict(type='str'),
action=dict(type='str', choices=['permit', 'deny']),
priority=dict(type='str',
choices=[
'default', 'lowest_priority', 'medium_priority',
'highest_priority'
]),
state=dict(type='str',
default='present',
choices=['absent', 'present', 'query']),
)
module = AnsibleModule(
argument_spec=argument_spec,
supports_check_mode=True,
required_if=[
['state', 'absent', ['filter']],
['state', 'present', ['filter']],
],
)
schema = module.params.get('schema')
template = module.params.get('template').replace(' ', '')
contract = module.params.get('contract')
contract_display_name = module.params.get('contract_display_name')
description = module.params.get('description')
contract_filter_type = module.params.get('contract_filter_type')
contract_scope = module.params.get('contract_scope')
filter_name = module.params.get('filter')
filter_directives = module.params.get('filter_directives')
filter_template = module.params.get('filter_template')
if filter_template is not None:
filter_template = filter_template.replace(' ', '')
filter_schema = module.params.get('filter_schema')
filter_type = module.params.get('filter_type')
qos_level = module.params.get('qos_level')
action = module.params.get('action')
priority = module.params.get('priority')
state = module.params.get('state')
mso = MSOModule(module)
contract_ftype = 'bothWay' if contract_filter_type == 'both-way' else 'oneWay'
if contract_filter_type == 'both-way' and filter_type != 'both-way':
mso.fail_json(
msg="You are adding 'one-way' filters to a 'both-way' contract")
elif contract_filter_type != 'both-way' and filter_type == 'both-way':
mso.fail_json(
msg="You are adding 'both-way' filters to a 'one-way' contract")
if filter_template is None:
filter_template = template
if filter_schema is None:
filter_schema = schema
filter_key = FILTER_KEYS.get(filter_type)
# Get schema
schema_id, schema_path, schema_obj = mso.query_schema(schema)
# Get template
templates = [t.get('name') for t in schema_obj.get('templates')]
if template not in templates:
mso.fail_json(
msg="Provided template '{0}' does not exist. Existing templates: {1}"
.format(template, ', '.join(templates)))
template_idx = templates.index(template)
filter_schema_id = mso.lookup_schema(filter_schema)
# Get contracts
mso.existing = {}
contract_idx = None
filter_idx = None
contracts = [
c.get('name')
for c in schema_obj.get('templates')[template_idx]['contracts']
]
if contract in contracts:
contract_idx = contracts.index(contract)
contract_obj = schema_obj.get(
'templates')[template_idx]['contracts'][contract_idx]
filters = [
f.get('filterRef') for f in schema_obj.get('templates')
[template_idx]['contracts'][contract_idx][filter_key]
]
filter_ref = mso.filter_ref(schema_id=filter_schema_id,
template=filter_template,
filter=filter_name)
if filter_ref in filters:
filter_idx = filters.index(filter_ref)
filter_path = '/templates/{0}/contracts/{1}/{2}/{3}'.format(
template, contract, filter_key, filter_name)
filter = contract_obj.get(filter_key)[filter_idx]
mso.existing = mso.update_filter_obj(contract_obj, filter,
filter_type)
if state == 'query':
if contract_idx is None:
mso.fail_json(
msg=
"Provided contract '{0}' does not exist. Existing contracts: {1}"
.format(contract, ', '.join(contracts)))
if filter_name is None:
mso.existing = contract_obj.get(filter_key)
for filter in mso.existing:
filter = mso.update_filter_obj(contract_obj, filter,
filter_type)
elif not mso.existing:
mso.fail_json(msg="FilterRef '{filter_ref}' not found".format(
filter_ref=filter_ref))
mso.exit_json()
ops = []
contract_path = '/templates/{0}/contracts/{1}'.format(template, contract)
filters_path = '/templates/{0}/contracts/{1}/{2}'.format(
template, contract, filter_key)
mso.previous = mso.existing
if state == 'absent':
mso.proposed = mso.sent = {}
if contract_idx is None:
# There was no contract to begin with
pass
elif filter_idx is None:
# There was no filter to begin with
pass
elif len(filters) == 1:
# There is only one filter, remove contract
mso.existing = {}
ops.append(dict(op='remove', path=contract_path))
else:
# Remove filter
mso.existing = {}
ops.append(dict(op='remove', path=filter_path))
elif state == 'present':
if filter_directives is None:
filter_directives = ['none']
if 'policy_compression' in filter_directives:
filter_directives.remove('policy_compression')
filter_directives.append('no_stats')
payload = dict(
filterRef=dict(
filterName=filter_name,
templateName=filter_template,
schemaId=filter_schema_id,
),
directives=filter_directives,
)
if action is not None:
payload.update(action=action)
if action == 'deny' and priority is not None:
priority_map = {
'lowest_priority': 'level1',
'medium_priority': 'level2',
'highest_priority': 'level3',
}
payload.update(priorityOverride=priority_map[priority])
mso.sanitize(
payload,
collate=True,
unwanted=['filterType', 'contractScope', 'contractFilterType'])
mso.existing = mso.sent
if contract_scope is None or contract_scope == 'vrf':
contract_scope = 'context'
if contract_idx is None:
# Contract does not exist, so we have to create it
if contract_display_name is None:
contract_display_name = contract
payload = {
'name': contract,
'displayName': contract_display_name,
'filterType': contract_ftype,
'scope': contract_scope,
}
if description is not None:
payload.update(description=description)
if qos_level is not None:
payload.update(prio=qos_level)
ops.append(
dict(op='add',
path='/templates/{0}/contracts/-'.format(template),
value=payload))
else:
# Contract exists, but may require an update
if contract_display_name is not None:
ops.append(
dict(op='replace',
path=contract_path + '/displayName',
value=contract_display_name))
ops.append(
dict(op='replace',
path=contract_path + '/filterType',
value=contract_ftype))
ops.append(
dict(op='replace',
path=contract_path + '/scope',
value=contract_scope))
if contract_display_name:
mso.existing['displayName'] = contract_display_name
else:
mso.existing['displayName'] = contract_obj.get('displayName')
mso.existing['filterType'] = filter_type
mso.existing['contractScope'] = contract_scope
mso.existing['contractFilterType'] = contract_ftype
if filter_idx is None:
# Filter does not exist, so we have to add it
ops.append(dict(op='add', path=filters_path + '/-',
value=mso.sent))
else:
# Filter exists, we have to update it
ops.append(dict(op='replace', path=filter_path, value=mso.sent))
if not module.check_mode and mso.existing != mso.previous:
mso.request(schema_path, method='PATCH', data=ops)
mso.exit_json()
