1. Packages
  2. Cisco NX OS Resource Provider
  3. API Docs
  4. Provider
Cisco NX-OS v0.0.2 published on Friday, Sep 29, 2023 by lbrlabs

nxos.Provider

Explore with Pulumi AI

nxos logo
Cisco NX-OS v0.0.2 published on Friday, Sep 29, 2023 by lbrlabs

    The provider type for the nxos package. By default, resources use package-wide configuration settings, however an explicit Provider instance may be created and passed during resource construction to achieve fine-grained programmatic control over provider settings. See the documentation for more information.

    Create Provider Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Provider(name: string, args?: ProviderArgs, opts?: CustomResourceOptions);
    @overload
    def Provider(resource_name: str,
                 args: Optional[ProviderArgs] = None,
                 opts: Optional[ResourceOptions] = None)
    
    @overload
    def Provider(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 devices: Optional[Sequence[ProviderDeviceArgs]] = None,
                 insecure: Optional[bool] = None,
                 password: Optional[str] = None,
                 retries: Optional[int] = None,
                 url: Optional[str] = None,
                 username: Optional[str] = None)
    func NewProvider(ctx *Context, name string, args *ProviderArgs, opts ...ResourceOption) (*Provider, error)
    public Provider(string name, ProviderArgs? args = null, CustomResourceOptions? opts = null)
    public Provider(String name, ProviderArgs args)
    public Provider(String name, ProviderArgs args, CustomResourceOptions options)
    
    type: pulumi:providers:nxos
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args ProviderArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args ProviderArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args ProviderArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ProviderArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ProviderArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Provider Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Provider resource accepts the following input properties:

    Devices List<Lbrlabs.PulumiPackage.Nxos.Inputs.ProviderDevice>
    This can be used to manage a list of devices from a single provider. All devices must use the same credentials. Each resource and data source has an optional attribute named device, which can then select a device by its name from this list.
    Insecure bool
    Allow insecure HTTPS client. This can also be set as the NXOS_INSECURE environment variable. Defaults to true.
    Password string
    Password for the NX-OS device account. This can also be set as the NXOS_PASSWORD environment variable.
    Retries int
    Number of retries for REST API calls. This can also be set as the NXOS_RETRIES environment variable. Defaults to 3.
    Url string
    URL of the Cisco NX-OS device. This can also be set as the NXOS_URL environment variable. If no URL is provided, the URL of the first device from the devices list is being used.
    Username string
    Username for the NX-OS device account. This can also be set as the NXOS_USERNAME environment variable.
    Devices []ProviderDeviceArgs
    This can be used to manage a list of devices from a single provider. All devices must use the same credentials. Each resource and data source has an optional attribute named device, which can then select a device by its name from this list.
    Insecure bool
    Allow insecure HTTPS client. This can also be set as the NXOS_INSECURE environment variable. Defaults to true.
    Password string
    Password for the NX-OS device account. This can also be set as the NXOS_PASSWORD environment variable.
    Retries int
    Number of retries for REST API calls. This can also be set as the NXOS_RETRIES environment variable. Defaults to 3.
    Url string
    URL of the Cisco NX-OS device. This can also be set as the NXOS_URL environment variable. If no URL is provided, the URL of the first device from the devices list is being used.
    Username string
    Username for the NX-OS device account. This can also be set as the NXOS_USERNAME environment variable.
    devices List<ProviderDevice>
    This can be used to manage a list of devices from a single provider. All devices must use the same credentials. Each resource and data source has an optional attribute named device, which can then select a device by its name from this list.
    insecure Boolean
    Allow insecure HTTPS client. This can also be set as the NXOS_INSECURE environment variable. Defaults to true.
    password String
    Password for the NX-OS device account. This can also be set as the NXOS_PASSWORD environment variable.
    retries Integer
    Number of retries for REST API calls. This can also be set as the NXOS_RETRIES environment variable. Defaults to 3.
    url String
    URL of the Cisco NX-OS device. This can also be set as the NXOS_URL environment variable. If no URL is provided, the URL of the first device from the devices list is being used.
    username String
    Username for the NX-OS device account. This can also be set as the NXOS_USERNAME environment variable.
    devices ProviderDevice[]
    This can be used to manage a list of devices from a single provider. All devices must use the same credentials. Each resource and data source has an optional attribute named device, which can then select a device by its name from this list.
    insecure boolean
    Allow insecure HTTPS client. This can also be set as the NXOS_INSECURE environment variable. Defaults to true.
    password string
    Password for the NX-OS device account. This can also be set as the NXOS_PASSWORD environment variable.
    retries number
    Number of retries for REST API calls. This can also be set as the NXOS_RETRIES environment variable. Defaults to 3.
    url string
    URL of the Cisco NX-OS device. This can also be set as the NXOS_URL environment variable. If no URL is provided, the URL of the first device from the devices list is being used.
    username string
    Username for the NX-OS device account. This can also be set as the NXOS_USERNAME environment variable.
    devices Sequence[ProviderDeviceArgs]
    This can be used to manage a list of devices from a single provider. All devices must use the same credentials. Each resource and data source has an optional attribute named device, which can then select a device by its name from this list.
    insecure bool
    Allow insecure HTTPS client. This can also be set as the NXOS_INSECURE environment variable. Defaults to true.
    password str
    Password for the NX-OS device account. This can also be set as the NXOS_PASSWORD environment variable.
    retries int
    Number of retries for REST API calls. This can also be set as the NXOS_RETRIES environment variable. Defaults to 3.
    url str
    URL of the Cisco NX-OS device. This can also be set as the NXOS_URL environment variable. If no URL is provided, the URL of the first device from the devices list is being used.
    username str
    Username for the NX-OS device account. This can also be set as the NXOS_USERNAME environment variable.
    devices List<Property Map>
    This can be used to manage a list of devices from a single provider. All devices must use the same credentials. Each resource and data source has an optional attribute named device, which can then select a device by its name from this list.
    insecure Boolean
    Allow insecure HTTPS client. This can also be set as the NXOS_INSECURE environment variable. Defaults to true.
    password String
    Password for the NX-OS device account. This can also be set as the NXOS_PASSWORD environment variable.
    retries Number
    Number of retries for REST API calls. This can also be set as the NXOS_RETRIES environment variable. Defaults to 3.
    url String
    URL of the Cisco NX-OS device. This can also be set as the NXOS_URL environment variable. If no URL is provided, the URL of the first device from the devices list is being used.
    username String
    Username for the NX-OS device account. This can also be set as the NXOS_USERNAME environment variable.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Provider resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Supporting Types

    ProviderDevice, ProviderDeviceArgs

    Name string
    Url string
    Name string
    Url string
    name String
    url String
    name string
    url string
    name str
    url str
    name String
    url String

    Package Details

    Repository
    nxos lbrlabs/pulumi-nxos
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the nxos Terraform Provider.
    nxos logo
    Cisco NX-OS v0.0.2 published on Friday, Sep 29, 2023 by lbrlabs