LldpProfile resource
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as scm from "@pulumi/scm";
const example = new scm.LldpProfile("example", {
folder: "All",
mode: "transmit-receive",
name: "lldp-profile-tf-1",
optionTlvs: {
managementAddress: {
enabled: true,
},
portDescription: true,
systemCapabilities: true,
systemDescription: false,
systemName: true,
},
snmpSyslogNotification: true,
});
import pulumi
import pulumi_scm as scm
example = scm.LldpProfile("example",
folder="All",
mode="transmit-receive",
name="lldp-profile-tf-1",
option_tlvs={
"management_address": {
"enabled": True,
},
"port_description": True,
"system_capabilities": True,
"system_description": False,
"system_name": True,
},
snmp_syslog_notification=True)
package main
import (
"github.com/pulumi/pulumi-scm/sdk/go/scm"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := scm.NewLldpProfile(ctx, "example", &scm.LldpProfileArgs{
Folder: pulumi.String("All"),
Mode: pulumi.String("transmit-receive"),
Name: pulumi.String("lldp-profile-tf-1"),
OptionTlvs: &scm.LldpProfileOptionTlvsArgs{
ManagementAddress: &scm.LldpProfileOptionTlvsManagementAddressArgs{
Enabled: pulumi.Bool(true),
},
PortDescription: pulumi.Bool(true),
SystemCapabilities: pulumi.Bool(true),
SystemDescription: pulumi.Bool(false),
SystemName: pulumi.Bool(true),
},
SnmpSyslogNotification: pulumi.Bool(true),
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Scm = Pulumi.Scm;
return await Deployment.RunAsync(() =>
{
var example = new Scm.LldpProfile("example", new()
{
Folder = "All",
Mode = "transmit-receive",
Name = "lldp-profile-tf-1",
OptionTlvs = new Scm.Inputs.LldpProfileOptionTlvsArgs
{
ManagementAddress = new Scm.Inputs.LldpProfileOptionTlvsManagementAddressArgs
{
Enabled = true,
},
PortDescription = true,
SystemCapabilities = true,
SystemDescription = false,
SystemName = true,
},
SnmpSyslogNotification = true,
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.scm.LldpProfile;
import com.pulumi.scm.LldpProfileArgs;
import com.pulumi.scm.inputs.LldpProfileOptionTlvsArgs;
import com.pulumi.scm.inputs.LldpProfileOptionTlvsManagementAddressArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var example = new LldpProfile("example", LldpProfileArgs.builder()
.folder("All")
.mode("transmit-receive")
.name("lldp-profile-tf-1")
.optionTlvs(LldpProfileOptionTlvsArgs.builder()
.managementAddress(LldpProfileOptionTlvsManagementAddressArgs.builder()
.enabled(true)
.build())
.portDescription(true)
.systemCapabilities(true)
.systemDescription(false)
.systemName(true)
.build())
.snmpSyslogNotification(true)
.build());
}
}
resources:
example:
type: scm:LldpProfile
properties:
folder: All
mode: transmit-receive
name: lldp-profile-tf-1
optionTlvs:
managementAddress:
enabled: true
portDescription: true
systemCapabilities: true
systemDescription: false
systemName: true
snmpSyslogNotification: true
Create LldpProfile Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new LldpProfile(name: string, args?: LldpProfileArgs, opts?: CustomResourceOptions);@overload
def LldpProfile(resource_name: str,
args: Optional[LldpProfileArgs] = None,
opts: Optional[ResourceOptions] = None)
@overload
def LldpProfile(resource_name: str,
opts: Optional[ResourceOptions] = None,
device: Optional[str] = None,
folder: Optional[str] = None,
mode: Optional[str] = None,
name: Optional[str] = None,
option_tlvs: Optional[LldpProfileOptionTlvsArgs] = None,
snippet: Optional[str] = None,
snmp_syslog_notification: Optional[bool] = None)func NewLldpProfile(ctx *Context, name string, args *LldpProfileArgs, opts ...ResourceOption) (*LldpProfile, error)public LldpProfile(string name, LldpProfileArgs? args = null, CustomResourceOptions? opts = null)
public LldpProfile(String name, LldpProfileArgs args)
public LldpProfile(String name, LldpProfileArgs args, CustomResourceOptions options)
type: scm:LldpProfile
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 LldpProfileArgs
- 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 LldpProfileArgs
- 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 LldpProfileArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args LldpProfileArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args LldpProfileArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var lldpProfileResource = new Scm.LldpProfile("lldpProfileResource", new()
{
Device = "string",
Folder = "string",
Mode = "string",
Name = "string",
OptionTlvs = new Scm.Inputs.LldpProfileOptionTlvsArgs
{
ManagementAddress = new Scm.Inputs.LldpProfileOptionTlvsManagementAddressArgs
{
Enabled = false,
Iplists = new[]
{
new Scm.Inputs.LldpProfileOptionTlvsManagementAddressIplistArgs
{
Interface = "string",
Ipv4 = "string",
Ipv6 = "string",
Name = "string",
},
},
},
PortDescription = false,
SystemCapabilities = false,
SystemDescription = false,
SystemName = false,
},
Snippet = "string",
SnmpSyslogNotification = false,
});
example, err := scm.NewLldpProfile(ctx, "lldpProfileResource", &scm.LldpProfileArgs{
Device: pulumi.String("string"),
Folder: pulumi.String("string"),
Mode: pulumi.String("string"),
Name: pulumi.String("string"),
OptionTlvs: &scm.LldpProfileOptionTlvsArgs{
ManagementAddress: &scm.LldpProfileOptionTlvsManagementAddressArgs{
Enabled: pulumi.Bool(false),
Iplists: scm.LldpProfileOptionTlvsManagementAddressIplistArray{
&scm.LldpProfileOptionTlvsManagementAddressIplistArgs{
Interface: pulumi.String("string"),
Ipv4: pulumi.String("string"),
Ipv6: pulumi.String("string"),
Name: pulumi.String("string"),
},
},
},
PortDescription: pulumi.Bool(false),
SystemCapabilities: pulumi.Bool(false),
SystemDescription: pulumi.Bool(false),
SystemName: pulumi.Bool(false),
},
Snippet: pulumi.String("string"),
SnmpSyslogNotification: pulumi.Bool(false),
})
var lldpProfileResource = new LldpProfile("lldpProfileResource", LldpProfileArgs.builder()
.device("string")
.folder("string")
.mode("string")
.name("string")
.optionTlvs(LldpProfileOptionTlvsArgs.builder()
.managementAddress(LldpProfileOptionTlvsManagementAddressArgs.builder()
.enabled(false)
.iplists(LldpProfileOptionTlvsManagementAddressIplistArgs.builder()
.interface_("string")
.ipv4("string")
.ipv6("string")
.name("string")
.build())
.build())
.portDescription(false)
.systemCapabilities(false)
.systemDescription(false)
.systemName(false)
.build())
.snippet("string")
.snmpSyslogNotification(false)
.build());
lldp_profile_resource = scm.LldpProfile("lldpProfileResource",
device="string",
folder="string",
mode="string",
name="string",
option_tlvs={
"management_address": {
"enabled": False,
"iplists": [{
"interface": "string",
"ipv4": "string",
"ipv6": "string",
"name": "string",
}],
},
"port_description": False,
"system_capabilities": False,
"system_description": False,
"system_name": False,
},
snippet="string",
snmp_syslog_notification=False)
const lldpProfileResource = new scm.LldpProfile("lldpProfileResource", {
device: "string",
folder: "string",
mode: "string",
name: "string",
optionTlvs: {
managementAddress: {
enabled: false,
iplists: [{
"interface": "string",
ipv4: "string",
ipv6: "string",
name: "string",
}],
},
portDescription: false,
systemCapabilities: false,
systemDescription: false,
systemName: false,
},
snippet: "string",
snmpSyslogNotification: false,
});
type: scm:LldpProfile
properties:
device: string
folder: string
mode: string
name: string
optionTlvs:
managementAddress:
enabled: false
iplists:
- interface: string
ipv4: string
ipv6: string
name: string
portDescription: false
systemCapabilities: false
systemDescription: false
systemName: false
snippet: string
snmpSyslogNotification: false
LldpProfile 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 LldpProfile resource accepts the following input properties:
- Device string
- The device in which the resource is defined
- Folder string
The folder in which the resource is defined
ℹ️ Note: You must specify exactly one of
device,folder, andsnippet.- Mode string
- LLDP mode
- Name string
- LLDP profile name
- Option
Tlvs LldpProfile Option Tlvs - Option tlvs
- Snippet string
The snippet in which the resource is defined
ℹ️ Note: You must specify exactly one of
device,folder, andsnippet.- Snmp
Syslog boolNotification - SNMP syslog notification
- Device string
- The device in which the resource is defined
- Folder string
The folder in which the resource is defined
ℹ️ Note: You must specify exactly one of
device,folder, andsnippet.- Mode string
- LLDP mode
- Name string
- LLDP profile name
- Option
Tlvs LldpProfile Option Tlvs Args - Option tlvs
- Snippet string
The snippet in which the resource is defined
ℹ️ Note: You must specify exactly one of
device,folder, andsnippet.- Snmp
Syslog boolNotification - SNMP syslog notification
- device String
- The device in which the resource is defined
- folder String
The folder in which the resource is defined
ℹ️ Note: You must specify exactly one of
device,folder, andsnippet.- mode String
- LLDP mode
- name String
- LLDP profile name
- option
Tlvs LldpProfile Option Tlvs - Option tlvs
- snippet String
The snippet in which the resource is defined
ℹ️ Note: You must specify exactly one of
device,folder, andsnippet.- snmp
Syslog BooleanNotification - SNMP syslog notification
- device string
- The device in which the resource is defined
- folder string
The folder in which the resource is defined
ℹ️ Note: You must specify exactly one of
device,folder, andsnippet.- mode string
- LLDP mode
- name string
- LLDP profile name
- option
Tlvs LldpProfile Option Tlvs - Option tlvs
- snippet string
The snippet in which the resource is defined
ℹ️ Note: You must specify exactly one of
device,folder, andsnippet.- snmp
Syslog booleanNotification - SNMP syslog notification
- device str
- The device in which the resource is defined
- folder str
The folder in which the resource is defined
ℹ️ Note: You must specify exactly one of
device,folder, andsnippet.- mode str
- LLDP mode
- name str
- LLDP profile name
- option_
tlvs LldpProfile Option Tlvs Args - Option tlvs
- snippet str
The snippet in which the resource is defined
ℹ️ Note: You must specify exactly one of
device,folder, andsnippet.- snmp_
syslog_ boolnotification - SNMP syslog notification
- device String
- The device in which the resource is defined
- folder String
The folder in which the resource is defined
ℹ️ Note: You must specify exactly one of
device,folder, andsnippet.- mode String
- LLDP mode
- name String
- LLDP profile name
- option
Tlvs Property Map - Option tlvs
- snippet String
The snippet in which the resource is defined
ℹ️ Note: You must specify exactly one of
device,folder, andsnippet.- snmp
Syslog BooleanNotification - SNMP syslog notification
Outputs
All input properties are implicitly available as output properties. Additionally, the LldpProfile resource produces the following output properties:
Look up Existing LldpProfile Resource
Get an existing LldpProfile resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: LldpProfileState, opts?: CustomResourceOptions): LldpProfile@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
device: Optional[str] = None,
folder: Optional[str] = None,
mode: Optional[str] = None,
name: Optional[str] = None,
option_tlvs: Optional[LldpProfileOptionTlvsArgs] = None,
snippet: Optional[str] = None,
snmp_syslog_notification: Optional[bool] = None,
tfid: Optional[str] = None) -> LldpProfilefunc GetLldpProfile(ctx *Context, name string, id IDInput, state *LldpProfileState, opts ...ResourceOption) (*LldpProfile, error)public static LldpProfile Get(string name, Input<string> id, LldpProfileState? state, CustomResourceOptions? opts = null)public static LldpProfile get(String name, Output<String> id, LldpProfileState state, CustomResourceOptions options)resources: _: type: scm:LldpProfile get: id: ${id}- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Device string
- The device in which the resource is defined
- Folder string
The folder in which the resource is defined
ℹ️ Note: You must specify exactly one of
device,folder, andsnippet.- Mode string
- LLDP mode
- Name string
- LLDP profile name
- Option
Tlvs LldpProfile Option Tlvs - Option tlvs
- Snippet string
The snippet in which the resource is defined
ℹ️ Note: You must specify exactly one of
device,folder, andsnippet.- Snmp
Syslog boolNotification - SNMP syslog notification
- Tfid string
- Device string
- The device in which the resource is defined
- Folder string
The folder in which the resource is defined
ℹ️ Note: You must specify exactly one of
device,folder, andsnippet.- Mode string
- LLDP mode
- Name string
- LLDP profile name
- Option
Tlvs LldpProfile Option Tlvs Args - Option tlvs
- Snippet string
The snippet in which the resource is defined
ℹ️ Note: You must specify exactly one of
device,folder, andsnippet.- Snmp
Syslog boolNotification - SNMP syslog notification
- Tfid string
- device String
- The device in which the resource is defined
- folder String
The folder in which the resource is defined
ℹ️ Note: You must specify exactly one of
device,folder, andsnippet.- mode String
- LLDP mode
- name String
- LLDP profile name
- option
Tlvs LldpProfile Option Tlvs - Option tlvs
- snippet String
The snippet in which the resource is defined
ℹ️ Note: You must specify exactly one of
device,folder, andsnippet.- snmp
Syslog BooleanNotification - SNMP syslog notification
- tfid String
- device string
- The device in which the resource is defined
- folder string
The folder in which the resource is defined
ℹ️ Note: You must specify exactly one of
device,folder, andsnippet.- mode string
- LLDP mode
- name string
- LLDP profile name
- option
Tlvs LldpProfile Option Tlvs - Option tlvs
- snippet string
The snippet in which the resource is defined
ℹ️ Note: You must specify exactly one of
device,folder, andsnippet.- snmp
Syslog booleanNotification - SNMP syslog notification
- tfid string
- device str
- The device in which the resource is defined
- folder str
The folder in which the resource is defined
ℹ️ Note: You must specify exactly one of
device,folder, andsnippet.- mode str
- LLDP mode
- name str
- LLDP profile name
- option_
tlvs LldpProfile Option Tlvs Args - Option tlvs
- snippet str
The snippet in which the resource is defined
ℹ️ Note: You must specify exactly one of
device,folder, andsnippet.- snmp_
syslog_ boolnotification - SNMP syslog notification
- tfid str
- device String
- The device in which the resource is defined
- folder String
The folder in which the resource is defined
ℹ️ Note: You must specify exactly one of
device,folder, andsnippet.- mode String
- LLDP mode
- name String
- LLDP profile name
- option
Tlvs Property Map - Option tlvs
- snippet String
The snippet in which the resource is defined
ℹ️ Note: You must specify exactly one of
device,folder, andsnippet.- snmp
Syslog BooleanNotification - SNMP syslog notification
- tfid String
Supporting Types
LldpProfileOptionTlvs, LldpProfileOptionTlvsArgs
- Management
Address LldpProfile Option Tlvs Management Address - Management address
- Port
Description bool - Option TLV Port Description
- System
Capabilities bool - Option TLV System Capabilities
- System
Description bool - Option TLV System Description
- System
Name bool - Option TLV System Name
- Management
Address LldpProfile Option Tlvs Management Address - Management address
- Port
Description bool - Option TLV Port Description
- System
Capabilities bool - Option TLV System Capabilities
- System
Description bool - Option TLV System Description
- System
Name bool - Option TLV System Name
- management
Address LldpProfile Option Tlvs Management Address - Management address
- port
Description Boolean - Option TLV Port Description
- system
Capabilities Boolean - Option TLV System Capabilities
- system
Description Boolean - Option TLV System Description
- system
Name Boolean - Option TLV System Name
- management
Address LldpProfile Option Tlvs Management Address - Management address
- port
Description boolean - Option TLV Port Description
- system
Capabilities boolean - Option TLV System Capabilities
- system
Description boolean - Option TLV System Description
- system
Name boolean - Option TLV System Name
- management_
address LldpProfile Option Tlvs Management Address - Management address
- port_
description bool - Option TLV Port Description
- system_
capabilities bool - Option TLV System Capabilities
- system_
description bool - Option TLV System Description
- system_
name bool - Option TLV System Name
- management
Address Property Map - Management address
- port
Description Boolean - Option TLV Port Description
- system
Capabilities Boolean - Option TLV System Capabilities
- system
Description Boolean - Option TLV System Description
- system
Name Boolean - Option TLV System Name
LldpProfileOptionTlvsManagementAddress, LldpProfileOptionTlvsManagementAddressArgs
- Enabled bool
- Management address enabled
- Iplists
List<Lldp
Profile Option Tlvs Management Address Iplist> - Iplist
- Enabled bool
- Management address enabled
- Iplists
[]Lldp
Profile Option Tlvs Management Address Iplist - Iplist
- enabled Boolean
- Management address enabled
- iplists
List<Lldp
Profile Option Tlvs Management Address Iplist> - Iplist
- enabled boolean
- Management address enabled
- iplists
Lldp
Profile Option Tlvs Management Address Iplist[] - Iplist
- enabled bool
- Management address enabled
- iplists
Sequence[Lldp
Profile Option Tlvs Management Address Iplist] - Iplist
- enabled Boolean
- Management address enabled
- iplists List<Property Map>
- Iplist
LldpProfileOptionTlvsManagementAddressIplist, LldpProfileOptionTlvsManagementAddressIplistArgs
- interface_ String
- Interface
- ipv4 String
- IPv4 Address
- ipv6 String
- IPv6 Address
- name String
- Name
Import
The following command can be used to import a resource not managed by Terraform:
bash
$ pulumi import scm:index/lldpProfile:LldpProfile example folder:::id
or
bash
$ pulumi import scm:index/lldpProfile:LldpProfile example :snippet::id
or
bash
$ pulumi import scm:index/lldpProfile:LldpProfile example ::device:id
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- scm pulumi/pulumi-scm
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
scmTerraform Provider.
