intersight_fibre_channel_zone_policy
Manage Fibre Channel Zone Policies for Cisco Intersight
Collection: cisco.intersight
Full Name: cisco.intersight.intersight_fibre_channel_zone_policy
Synopsis
Manage Fibre Channel Zone Policies for Cisco Intersight
Parameters
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
| api_private_key | string | Filename (absolute path) or string of PEM formatted private key data to be used for Intersight API authentication. If a string is used, Ansible vault should be used to encrypt string data. Ex. ansible-vault encrypt_string –vault-id tme@/Users/dsoper/Documents/vault_password_file ‘—–BEGIN EC PRIVATE KEY—– | ||
| api_uri | string | https://intersight.com/api/v1 | URI used to access the Intersight API. If not set, the value of the INTERSIGHT_API_URI environment variable is used. | |
| api_key_id | string | Public API Key ID associated with the private key. If not set, the value of the INTERSIGHT_API_KEY_ID environment variable is used. Required if I(api_bearer_token) is not provided. | ||
| api_bearer_token | string | Bearer token for OAuth2 authentication with the Intersight API. When provided, I(api_key_id) and I(api_private_key) are not required and the C(cryptography) Python library is not needed. If not set, the value of the INTERSIGHT_API_BEARER_TOKEN environment variable is used. Secret value; omitted from logs and results. | ||
| validate_certs | bool | true | Boolean control for verifying the api_uri TLS certificate | |
| use_proxy | bool | true | If C(no), it will not use a proxy, even if one is defined in an environment variable on the target hosts. | |
| state | string | present | If C(present), will verify the resource is present and will create if needed. If C(absent), will verify the resource is absent and will delete if needed. Choices: present, absent | |
| organization | string | default | The name of the Organization this resource is assigned to. Policies created within a Custom Organization are applicable only to devices in the same Organization. Use ‘default’ for the default organization. | |
| name | string | yes | The name assigned to the Fibre Channel Zone Policy. Must be unique within the organization. The name must be between 1 and 64 alphanumeric characters, allowing special characters :-_. | |
| description | string | The user-defined description for the Fibre Channel Zone Policy. Description can contain letters(a-z, A-Z), numbers(0-9), hyphen(-), period(.), colon(:), or an underscore(_). | ||
| tags | list | List of tags in Key: | ||
| fc_target_zoning_type | string | None | Type of FC zoning configuration. C(SIST) - Single Initiator Single Target zoning. C(SIMT) - Single Initiator Multiple Target zoning. C(None) - No zoning. When None is selected, targets cannot be added and existing targets will be disabled. Choices: SIST, SIMT, None | |
| fc_target_members | list | List of FC target members (zones) to be created within the FC zone policy. Each target defines a WWPN that is a member of the FC zone. Leave empty when fc_target_zoning_type is None. Nested options: name (str) required; wwpn (str) required; switch_id (str) default=A; vsan_id (int) required |
Example
yaml
- cisco.intersight.intersight_fibre_channel_zone_policy:
api_key_id: '{{ api_key_id }}'
api_private_key: '{{ api_private_key }}'
description: FC Zone policy with SIMT zoning
fc_target_members:
- name: target1
switch_id: A
vsan_id: 100
wwpn: 21:00:00:e0:8b:05:05:04
- name: target2
switch_id: B
vsan_id: 100
wwpn: 21:00:00:e0:8b:05:05:03
- name: target3
switch_id: A
vsan_id: 200
wwpn: 21:00:00:e0:8b:05:05:09
fc_target_zoning_type: SIMT
name: fc-zone-policy-simt
organization: default
state: present
tags:
- Key: Environment
Value: Production
name: Create FC Zone Policy with SIMT zoning and multiple targets
- cisco.intersight.intersight_fibre_channel_zone_policy:
api_key_id: '{{ api_key_id }}'
api_private_key: '{{ api_private_key }}'
description: FC Zone policy with SIST zoning
fc_target_members:
- name: single-target
switch_id: A
vsan_id: 100
wwpn: 21:00:00:e0:8b:05:05:01
fc_target_zoning_type: SIST
name: fc-zone-policy-sist
organization: default
state: present
name: Create FC Zone Policy with SIST zoning
- cisco.intersight.intersight_fibre_channel_zone_policy:
api_key_id: '{{ api_key_id }}'
api_private_key: '{{ api_private_key }}'
description: FC Zone policy with no zoning
fc_target_zoning_type: None
name: fc-zone-policy-none
organization: default
state: present
name: Create FC Zone Policy with no zoning (None type)
- cisco.intersight.intersight_fibre_channel_zone_policy:
api_key_id: '{{ api_key_id }}'
api_private_key: '{{ api_private_key }}'
description: Updated FC Zone policy
fc_target_members:
- name: target1
switch_id: A
vsan_id: 100
wwpn: 21:00:00:e0:8b:05:05:04
- name: target2
switch_id: B
vsan_id: 100
wwpn: 21:00:00:e0:8b:05:05:03
- name: target3
switch_id: A
vsan_id: 200
wwpn: 21:00:00:e0:8b:05:05:09
- name: target4
switch_id: B
vsan_id: 200
wwpn: 21:00:00:e0:8b:05:05:10
fc_target_zoning_type: SIMT
name: fc-zone-policy-simt
organization: default
state: present
name: Update FC Zone Policy - add new target
- cisco.intersight.intersight_fibre_channel_zone_policy:
api_key_id: '{{ api_key_id }}'
api_private_key: '{{ api_private_key }}'
fc_target_members:
- name: target1
switch_id: A
vsan_id: 100
wwpn: 21:00:00:e0:8b:05:05:04
- name: target3
switch_id: A
vsan_id: 200
wwpn: 21:00:00:e0:8b:05:05:09
fc_target_zoning_type: SIMT
name: fc-zone-policy-simt
organization: default
state: present
name: Update FC Zone Policy - remove a target (only specify remaining targets)
- cisco.intersight.intersight_fibre_channel_zone_policy:
api_key_id: '{{ api_key_id }}'
api_private_key: '{{ api_private_key }}'
name: fc-zone-policy-simt
organization: default
state: absent
name: Delete FC Zone Policy