intersight_san_connectivity_policy
Manage SAN Connectivity Policies and vHBAs for Cisco Intersight
Collection: cisco.intersight
Full Name: cisco.intersight.intersight_san_connectivity_policy
Synopsis
Manage SAN Connectivity Policies and vHBAs 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 SAN Connectivity 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 SAN Connectivity 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: | ||
| target_platform | string | Standalone | The platform type for which the SAN Connectivity policy is intended. C(Standalone) for Standalone servers. C(FIAttached) for fabric interconnect attached servers. Note SAN Connectivity policies are not supported on unified edge servers. Choices: Standalone, FIAttached | |
| placement_mode | string | custom | The mode used for placement of vHBAs on network adapters. C(custom) requires manual placement specification for each vHBA. C(auto) automatically distributes vHBAs between adapters during profile deployment. Only applicable for FIAttached target platform. Choices: custom, auto | |
| wwnn_address_type | string | pool | Type of WWNN address assignment. C(pool) to use a WWNN pool. C(static) to manually assign a static WWNN address. Only applicable when target_platform is FIAttached. Choices: pool, static | |
| wwnn_pool | string | The WWNN pool that is assigned for WWNN address assignment. Required when wwnn_address_type is pool and target platform is FIAttached. Only applicable for FIAttached target platform. | ||
| static_wwnn_address | string | The WWNN address for the server node must be in hexadecimal format xx:xx:xx:xx:xx:xx:xx:xx. Allowed ranges are 20:00:00:00:00:00:00:00 to 20:FF:FF:FF:FF:FF:FF:FF or from 50:00:00:00:00:00:00:00 to 5F:FF:FF:FF:FF:FF:FF:FF. To ensure uniqueness of WWN’s in the SAN fabric, you are strongly encouraged to use the WWN prefix - 20:00:00:25:B5:xx:xx:xx. Required when wwnn_address_type is static and target platform is FIAttached. Only applicable for FIAttached target platform. | ||
| vhbas | list | List of vHBAs to be created and attached to the SAN Connectivity policy. Each vHBA will be configured with the specified fibre channel policies. Configuration options vary based on target_platform. Nested options: name (str) required; state (str) default=present; vhba_type (str); slot_id (str); pci_link (int) default=0; uplink_port (int) default=0; pci_order (int) default=0; persistent_lun_bindings (bool) default=false; fibre_channel_network_policy (str); fibre_channel_qos_policy (str); fibre_channel_adapter_policy (str); pin_group_name (str); wwpn_address_type (str) default=pool; wwpn_pool (str); static_wwpn_address (str); switch_id (str) default=a; auto_slot_id (bool) default=true; auto_pci_link (bool) default=true; pci_link_assignment_mode (str); fibre_channel_zone_policies (list) |
Example
yaml
- cisco.intersight.intersight_san_connectivity_policy:
api_key_id: '{{ api_key_id }}'
api_private_key: '{{ api_private_key }}'
description: SAN connectivity policy for standalone servers
name: standalone-san-policy
organization: default
state: present
tags:
- Key: Environment
Value: Production
- Key: Site
Value: DataCenter-A
target_platform: Standalone
vhbas:
- fibre_channel_adapter_policy: fc-adapter-policy
fibre_channel_network_policy: fc-network-policy
fibre_channel_qos_policy: fc-qos-policy
name: vhba0
pci_link: 0
pci_order: 0
persistent_lun_bindings: false
slot_id: "1"
uplink_port: 0
vhba_type: fc-initiator
- fibre_channel_adapter_policy: fc-adapter-policy
fibre_channel_network_policy: fc-network-policy
fibre_channel_qos_policy: fc-qos-policy
name: vhba1
pci_link: 0
pci_order: 5
persistent_lun_bindings: true
slot_id: "4"
uplink_port: 2
vhba_type: fc-nvme-initiator
name: Create a SAN Connectivity Policy for Standalone servers
- cisco.intersight.intersight_san_connectivity_policy:
api_key_id: '{{ api_key_id }}'
api_private_key: '{{ api_private_key }}'
description: SAN policy with automatic vHBA placement
name: auto-placement-san-policy
organization: default
placement_mode: auto
state: present
target_platform: FIAttached
vhbas:
- fibre_channel_adapter_policy: fc-adapter-policy
fibre_channel_network_policy: fc-network-policy
fibre_channel_qos_policy: fc-qos-policy
name: vhba-auto-1
switch_id: a
vhba_type: fc-initiator
wwpn_address_type: pool
wwpn_pool: default-wwpn-pool
- fibre_channel_adapter_policy: fc-adapter-policy
fibre_channel_network_policy: fc-network-policy
fibre_channel_qos_policy: fc-qos-policy
name: vhba-auto-2
switch_id: b
vhba_type: fc-initiator
wwpn_address_type: pool
wwpn_pool: default-wwpn-pool
wwnn_address_type: pool
wwnn_pool: default-wwnn-pool
name: Create a SAN Connectivity Policy with auto placement
- cisco.intersight.intersight_san_connectivity_policy:
api_key_id: '{{ api_key_id }}'
api_private_key: '{{ api_private_key }}'
description: SAN connectivity policy for FI-attached servers
name: fi-attached-san-policy
organization: default
placement_mode: custom
state: present
tags:
- Key: Environment
Value: Production
target_platform: FIAttached
vhbas:
- auto_pci_link: true
auto_slot_id: true
fibre_channel_adapter_policy: fc-adapter-policy
fibre_channel_network_policy: fc-network-policy
fibre_channel_qos_policy: fc-qos-policy
fibre_channel_zone_policies:
- fc-zone-policy-1
name: vhba-a
pci_order: 0
persistent_lun_bindings: false
switch_id: a
vhba_type: fc-initiator
wwpn_address_type: pool
wwpn_pool: default-wwpn-pool
- auto_pci_link: true
auto_slot_id: true
fibre_channel_adapter_policy: fc-adapter-policy
fibre_channel_network_policy: fc-network-policy
fibre_channel_qos_policy: fc-qos-policy
fibre_channel_zone_policies:
- fc-zone-policy-1
name: vhba-b
pci_order: 1
persistent_lun_bindings: false
switch_id: b
vhba_type: fc-initiator
wwpn_address_type: pool
wwpn_pool: default-wwpn-pool
wwnn_address_type: pool
wwnn_pool: default-wwnn-pool
name: Create a SAN Connectivity Policy for FI-Attached servers with WWNN pool
- cisco.intersight.intersight_san_connectivity_policy:
api_key_id: '{{ api_key_id }}'
api_private_key: '{{ api_private_key }}'
description: SAN connectivity policy with static addresses
name: fi-attached-static-san-policy
organization: default
placement_mode: custom
state: present
target_platform: FIAttached
vhbas:
- auto_pci_link: false
auto_slot_id: false
fibre_channel_adapter_policy: fc-adapter-policy
fibre_channel_network_policy: fc-network-policy
fibre_channel_qos_policy: fc-qos-policy
fibre_channel_zone_policies:
- fc-zone-policy-1
name: vhba-static
pci_link_assignment_mode: load-balanced
pci_order: 1
persistent_lun_bindings: true
slot_id: "2"
static_wwpn_address: "50:00:00:00:00:00:00:00"
switch_id: b
vhba_type: fc-target
wwpn_address_type: static
wwnn_address_type: pool
wwnn_pool: default-wwnn-pool
name: Create a SAN Connectivity Policy for FI-Attached with static WWPN
- cisco.intersight.intersight_san_connectivity_policy:
api_key_id: '{{ api_key_id }}'
api_private_key: '{{ api_private_key }}'
description: SAN connectivity with custom placement
name: fi-attached-advanced-placement
organization: default
placement_mode: custom
state: present
static_wwnn_address: 20:00:00:25:B5:00:00:01
target_platform: FIAttached
vhbas:
- auto_pci_link: false
auto_slot_id: false
fibre_channel_adapter_policy: fc-adapter-policy
fibre_channel_network_policy: fc-network-policy
fibre_channel_qos_policy: fc-qos-policy
name: vhba-custom
pci_link: 1
pci_link_assignment_mode: custom
pci_order: 3
persistent_lun_bindings: false
pin_group_name: pingroup-a
slot_id: MLOM
switch_id: a
vhba_type: fc-initiator
wwpn_address_type: pool
wwpn_pool: wwpn-pool
wwnn_address_type: static
name: Create a SAN Connectivity Policy for FI-Attached with advanced placement
- cisco.intersight.intersight_san_connectivity_policy:
api_key_id: '{{ api_key_id }}'
api_private_key: '{{ api_private_key }}'
description: Policy demonstrating vHBA state management
name: mixed-vhba-states-policy
organization: default
state: present
target_platform: Standalone
vhbas:
- fibre_channel_adapter_policy: fc-adapter-policy
fibre_channel_network_policy: fc-network-policy
fibre_channel_qos_policy: fc-qos-policy
name: vhba0
pci_link: 0
pci_order: 0
persistent_lun_bindings: false
slot_id: "1"
state: present
uplink_port: 0
vhba_type: fc-initiator
- name: vhba-old
state: absent
- fibre_channel_adapter_policy: fc-adapter-policy
fibre_channel_network_policy: fc-network-policy
fibre_channel_qos_policy: fc-qos-policy
name: vhba-new
pci_link: 0
pci_order: 1
persistent_lun_bindings: true
slot_id: "3"
state: present
uplink_port: 1
vhba_type: fc-nvme-initiator
name: Update SAN connectivity policy - manage vHBA states
- cisco.intersight.intersight_san_connectivity_policy:
api_key_id: '{{ api_key_id }}'
api_private_key: '{{ api_private_key }}'
name: old-san-policy
state: absent
name: Delete a SAN Connectivity Policy