1. Packages
  2. Routeros Provider
  3. API Docs
  4. IpUpnpInterfaces
routeros 1.83.0 published on Wednesday, Apr 16, 2025 by terraform-routeros

routeros.IpUpnpInterfaces

Explore with Pulumi AI

Example Usage

Coming soon!
Coming soon!
Coming soon!
Coming soon!
Coming soon!
resources:
  test:
    type: routeros:IpUpnpInterfaces
    properties:
      forcedExternalIp: 0.0.0.0
      interface: ether1
      type: external
Copy

Create IpUpnpInterfaces Resource

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

Constructor syntax

new IpUpnpInterfaces(name: string, args: IpUpnpInterfacesArgs, opts?: CustomResourceOptions);
@overload
def IpUpnpInterfaces(resource_name: str,
                     args: IpUpnpInterfacesArgs,
                     opts: Optional[ResourceOptions] = None)

@overload
def IpUpnpInterfaces(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     interface: Optional[str] = None,
                     ___id_: Optional[float] = None,
                     ___path_: Optional[str] = None,
                     ___unset_: Optional[str] = None,
                     disabled: Optional[bool] = None,
                     forced_ip: Optional[str] = None,
                     ip_upnp_interfaces_id: Optional[str] = None,
                     type: Optional[str] = None)
func NewIpUpnpInterfaces(ctx *Context, name string, args IpUpnpInterfacesArgs, opts ...ResourceOption) (*IpUpnpInterfaces, error)
public IpUpnpInterfaces(string name, IpUpnpInterfacesArgs args, CustomResourceOptions? opts = null)
public IpUpnpInterfaces(String name, IpUpnpInterfacesArgs args)
public IpUpnpInterfaces(String name, IpUpnpInterfacesArgs args, CustomResourceOptions options)
type: routeros:IpUpnpInterfaces
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

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

IpUpnpInterfaces 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 IpUpnpInterfaces resource accepts the following input properties:

Interface This property is required. string
Interface name on which uPnP will be running.
Disabled bool
ForcedIp string
Allow specifying what public IP to use if the external interface has more than one IP available.
IpUpnpInterfacesId string
Type string
UPnP interface type: * external - the interface a global IP address is assigned to * internal - router's local interface the clients are connected to
___id_ double
Resource ID type (.id / name). This is an internal service field, setting a value is not required.
___path_ string
Resource path for CRUD operations. This is an internal service field, setting a value is not required.
___unset_ string
A set of fields that require setting/unsetting. This is an internal service field, setting a value is not required.
Interface This property is required. string
Interface name on which uPnP will be running.
Disabled bool
ForcedIp string
Allow specifying what public IP to use if the external interface has more than one IP available.
IpUpnpInterfacesId string
Type string
UPnP interface type: * external - the interface a global IP address is assigned to * internal - router's local interface the clients are connected to
___id_ float64
Resource ID type (.id / name). This is an internal service field, setting a value is not required.
___path_ string
Resource path for CRUD operations. This is an internal service field, setting a value is not required.
___unset_ string
A set of fields that require setting/unsetting. This is an internal service field, setting a value is not required.
interface_ This property is required. String
Interface name on which uPnP will be running.
___id_ Double
Resource ID type (.id / name). This is an internal service field, setting a value is not required.
___path_ String
Resource path for CRUD operations. This is an internal service field, setting a value is not required.
___unset_ String
A set of fields that require setting/unsetting. This is an internal service field, setting a value is not required.
disabled Boolean
forcedIp String
Allow specifying what public IP to use if the external interface has more than one IP available.
ipUpnpInterfacesId String
type String
UPnP interface type: * external - the interface a global IP address is assigned to * internal - router's local interface the clients are connected to
interface This property is required. string
Interface name on which uPnP will be running.
___id_ number
Resource ID type (.id / name). This is an internal service field, setting a value is not required.
___path_ string
Resource path for CRUD operations. This is an internal service field, setting a value is not required.
___unset_ string
A set of fields that require setting/unsetting. This is an internal service field, setting a value is not required.
disabled boolean
forcedIp string
Allow specifying what public IP to use if the external interface has more than one IP available.
ipUpnpInterfacesId string
type string
UPnP interface type: * external - the interface a global IP address is assigned to * internal - router's local interface the clients are connected to
interface This property is required. str
Interface name on which uPnP will be running.
___id_ float
Resource ID type (.id / name). This is an internal service field, setting a value is not required.
___path_ str
Resource path for CRUD operations. This is an internal service field, setting a value is not required.
___unset_ str
A set of fields that require setting/unsetting. This is an internal service field, setting a value is not required.
disabled bool
forced_ip str
Allow specifying what public IP to use if the external interface has more than one IP available.
ip_upnp_interfaces_id str
type str
UPnP interface type: * external - the interface a global IP address is assigned to * internal - router's local interface the clients are connected to
interface This property is required. String
Interface name on which uPnP will be running.
___id_ Number
Resource ID type (.id / name). This is an internal service field, setting a value is not required.
___path_ String
Resource path for CRUD operations. This is an internal service field, setting a value is not required.
___unset_ String
A set of fields that require setting/unsetting. This is an internal service field, setting a value is not required.
disabled Boolean
forcedIp String
Allow specifying what public IP to use if the external interface has more than one IP available.
ipUpnpInterfacesId String
type String
UPnP interface type: * external - the interface a global IP address is assigned to * internal - router's local interface the clients are connected to

Outputs

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

Dynamic bool
Configuration item created by software, not by management interface. It is not exported, and cannot be directly modified.
Id string
The provider-assigned unique ID for this managed resource.
Dynamic bool
Configuration item created by software, not by management interface. It is not exported, and cannot be directly modified.
Id string
The provider-assigned unique ID for this managed resource.
dynamic Boolean
Configuration item created by software, not by management interface. It is not exported, and cannot be directly modified.
id String
The provider-assigned unique ID for this managed resource.
dynamic boolean
Configuration item created by software, not by management interface. It is not exported, and cannot be directly modified.
id string
The provider-assigned unique ID for this managed resource.
dynamic bool
Configuration item created by software, not by management interface. It is not exported, and cannot be directly modified.
id str
The provider-assigned unique ID for this managed resource.
dynamic Boolean
Configuration item created by software, not by management interface. It is not exported, and cannot be directly modified.
id String
The provider-assigned unique ID for this managed resource.

Look up Existing IpUpnpInterfaces Resource

Get an existing IpUpnpInterfaces 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?: IpUpnpInterfacesState, opts?: CustomResourceOptions): IpUpnpInterfaces
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        ___id_: Optional[float] = None,
        ___path_: Optional[str] = None,
        ___unset_: Optional[str] = None,
        disabled: Optional[bool] = None,
        dynamic: Optional[bool] = None,
        forced_ip: Optional[str] = None,
        interface: Optional[str] = None,
        ip_upnp_interfaces_id: Optional[str] = None,
        type: Optional[str] = None) -> IpUpnpInterfaces
func GetIpUpnpInterfaces(ctx *Context, name string, id IDInput, state *IpUpnpInterfacesState, opts ...ResourceOption) (*IpUpnpInterfaces, error)
public static IpUpnpInterfaces Get(string name, Input<string> id, IpUpnpInterfacesState? state, CustomResourceOptions? opts = null)
public static IpUpnpInterfaces get(String name, Output<String> id, IpUpnpInterfacesState state, CustomResourceOptions options)
resources:  _:    type: routeros:IpUpnpInterfaces    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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.
The following state arguments are supported:
Disabled bool
Dynamic bool
Configuration item created by software, not by management interface. It is not exported, and cannot be directly modified.
ForcedIp string
Allow specifying what public IP to use if the external interface has more than one IP available.
Interface string
Interface name on which uPnP will be running.
IpUpnpInterfacesId string
Type string
UPnP interface type: * external - the interface a global IP address is assigned to * internal - router's local interface the clients are connected to
___id_ double
Resource ID type (.id / name). This is an internal service field, setting a value is not required.
___path_ string
Resource path for CRUD operations. This is an internal service field, setting a value is not required.
___unset_ string
A set of fields that require setting/unsetting. This is an internal service field, setting a value is not required.
Disabled bool
Dynamic bool
Configuration item created by software, not by management interface. It is not exported, and cannot be directly modified.
ForcedIp string
Allow specifying what public IP to use if the external interface has more than one IP available.
Interface string
Interface name on which uPnP will be running.
IpUpnpInterfacesId string
Type string
UPnP interface type: * external - the interface a global IP address is assigned to * internal - router's local interface the clients are connected to
___id_ float64
Resource ID type (.id / name). This is an internal service field, setting a value is not required.
___path_ string
Resource path for CRUD operations. This is an internal service field, setting a value is not required.
___unset_ string
A set of fields that require setting/unsetting. This is an internal service field, setting a value is not required.
___id_ Double
Resource ID type (.id / name). This is an internal service field, setting a value is not required.
___path_ String
Resource path for CRUD operations. This is an internal service field, setting a value is not required.
___unset_ String
A set of fields that require setting/unsetting. This is an internal service field, setting a value is not required.
disabled Boolean
dynamic Boolean
Configuration item created by software, not by management interface. It is not exported, and cannot be directly modified.
forcedIp String
Allow specifying what public IP to use if the external interface has more than one IP available.
interface_ String
Interface name on which uPnP will be running.
ipUpnpInterfacesId String
type String
UPnP interface type: * external - the interface a global IP address is assigned to * internal - router's local interface the clients are connected to
___id_ number
Resource ID type (.id / name). This is an internal service field, setting a value is not required.
___path_ string
Resource path for CRUD operations. This is an internal service field, setting a value is not required.
___unset_ string
A set of fields that require setting/unsetting. This is an internal service field, setting a value is not required.
disabled boolean
dynamic boolean
Configuration item created by software, not by management interface. It is not exported, and cannot be directly modified.
forcedIp string
Allow specifying what public IP to use if the external interface has more than one IP available.
interface string
Interface name on which uPnP will be running.
ipUpnpInterfacesId string
type string
UPnP interface type: * external - the interface a global IP address is assigned to * internal - router's local interface the clients are connected to
___id_ float
Resource ID type (.id / name). This is an internal service field, setting a value is not required.
___path_ str
Resource path for CRUD operations. This is an internal service field, setting a value is not required.
___unset_ str
A set of fields that require setting/unsetting. This is an internal service field, setting a value is not required.
disabled bool
dynamic bool
Configuration item created by software, not by management interface. It is not exported, and cannot be directly modified.
forced_ip str
Allow specifying what public IP to use if the external interface has more than one IP available.
interface str
Interface name on which uPnP will be running.
ip_upnp_interfaces_id str
type str
UPnP interface type: * external - the interface a global IP address is assigned to * internal - router's local interface the clients are connected to
___id_ Number
Resource ID type (.id / name). This is an internal service field, setting a value is not required.
___path_ String
Resource path for CRUD operations. This is an internal service field, setting a value is not required.
___unset_ String
A set of fields that require setting/unsetting. This is an internal service field, setting a value is not required.
disabled Boolean
dynamic Boolean
Configuration item created by software, not by management interface. It is not exported, and cannot be directly modified.
forcedIp String
Allow specifying what public IP to use if the external interface has more than one IP available.
interface String
Interface name on which uPnP will be running.
ipUpnpInterfacesId String
type String
UPnP interface type: * external - the interface a global IP address is assigned to * internal - router's local interface the clients are connected to

Import

#The ID can be found via API or the terminal

#The command for the terminal is -> :put [/ip/upnp/interfaces get [print show-ids]]

$ pulumi import routeros:index/ipUpnpInterfaces:IpUpnpInterfaces test '*1'
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
routeros terraform-routeros/terraform-provider-routeros
License
Notes
This Pulumi package is based on the routeros Terraform Provider.