intersight_fibre_channel_network_policy

Manage Fibre Channel Network Policies for Cisco Intersight

Collection: cisco.intersight

Full Name: cisco.intersight.intersight_fibre_channel_network_policy

Synopsis

Manage Fibre Channel Network 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—– —–END EC PRIVATE KEY—–’ If not set, the value of the INTERSIGHT_API_PRIVATE_KEY environment variable is used. Required if I(api_bearer_token) is not provided. Secret value; omitted from logs and results.
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 Network 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 Network 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: Value: format.
default_vlan	int		`0`	The default VLAN ID for the Fibre Channel network. Valid range is 0 to 4094. A value of 0 means the VLAN is not configured.
vsan_id	int		`1`	The VSAN (Virtual Storage Area Network) ID for the Fibre Channel network. Valid range is 1 to 4094.

Example

yaml

- cisco.intersight.intersight_fibre_channel_network_policy:
    api_key_id: '{{ api_key_id }}'
    api_private_key: '{{ api_private_key }}'
    description: Fibre Channel Network policy with default values
    name: fc-network-default
    organization: default
    state: present
  name: Create Fibre Channel Network Policy with default settings

- cisco.intersight.intersight_fibre_channel_network_policy:
    api_key_id: '{{ api_key_id }}'
    api_private_key: '{{ api_private_key }}'
    default_vlan: 100
    description: Fibre Channel Network policy for VSAN 100
    name: fc-network-vsan100
    organization: default
    state: present
    tags:
        - Key: Environment
          Value: Production
    vsan_id: 100
  name: Create Fibre Channel Network Policy with custom VSAN settings

- cisco.intersight.intersight_fibre_channel_network_policy:
    api_key_id: '{{ api_key_id }}'
    api_private_key: '{{ api_private_key }}'
    default_vlan: 200
    description: Custom Fibre Channel Network policy
    name: fc-network-custom
    organization: Engineering
    state: present
    vsan_id: 300
  name: Create Fibre Channel Network Policy with VLAN and different VSAN

- cisco.intersight.intersight_fibre_channel_network_policy:
    api_key_id: '{{ api_key_id }}'
    api_private_key: '{{ api_private_key }}'
    default_vlan: 4094
    description: Fibre Channel Network policy with maximum VSAN ID
    name: fc-network-max-vsan
    organization: default
    state: present
    vsan_id: 4094
  name: Create Fibre Channel Network Policy with maximum VSAN ID

- cisco.intersight.intersight_fibre_channel_network_policy:
    api_key_id: '{{ api_key_id }}'
    api_private_key: '{{ api_private_key }}'
    description: Updated Fibre Channel Network policy description
    name: fc-network-default
    organization: default
    state: present
  name: Update Fibre Channel Network Policy description

- cisco.intersight.intersight_fibre_channel_network_policy:
    api_key_id: '{{ api_key_id }}'
    api_private_key: '{{ api_private_key }}'
    name: fc-network-default
    organization: default
    state: absent
  name: Delete Fibre Channel Network Policy