1. Packages
  2. Packages
  3. Freebox
  4. API Docs
  5. vpn
  6. Server
Viewing docs for Freebox v0.3.11
published on Friday, Jul 3, 2026 by OlivierPaquien
freebox logo
Viewing docs for Freebox v0.3.11
published on Friday, Jul 3, 2026 by OlivierPaquien

    Create Server Resource

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

    Constructor syntax

    new Server(name: string, args?: ServerArgs, opts?: CustomResourceOptions);
    @overload
    def Server(resource_name: str,
               args: Optional[ServerArgs] = None,
               opts: Optional[ResourceOptions] = None)
    
    @overload
    def Server(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               enabled: Optional[bool] = None,
               push_dhcp: Optional[bool] = None,
               server_ip: Optional[str] = None,
               server_mask: Optional[str] = None,
               server_port: Optional[int] = None)
    func NewServer(ctx *Context, name string, args *ServerArgs, opts ...ResourceOption) (*Server, error)
    public Server(string name, ServerArgs? args = null, CustomResourceOptions? opts = null)
    public Server(String name, ServerArgs args)
    public Server(String name, ServerArgs args, CustomResourceOptions options)
    
    type: freebox:vpn:Server
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "freebox_vpn_server" "name" {
        # resource properties
    }

    Parameters

    name string
    The unique name of the resource.
    args ServerArgs
    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 ServerArgs
    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 ServerArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ServerArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ServerArgs
    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 serverResource = new Freebox.Vpn.Server("serverResource", new()
    {
        Enabled = false,
        PushDhcp = false,
        ServerIp = "string",
        ServerMask = "string",
        ServerPort = 0,
    });
    
    example, err := vpn.NewServer(ctx, "serverResource", &vpn.ServerArgs{
    	Enabled:    pulumi.Bool(false),
    	PushDhcp:   pulumi.Bool(false),
    	ServerIp:   pulumi.String("string"),
    	ServerMask: pulumi.String("string"),
    	ServerPort: pulumi.Int(0),
    })
    
    resource "freebox_vpn_server" "serverResource" {
      enabled     = false
      push_dhcp   = false
      server_ip   = "string"
      server_mask = "string"
      server_port = 0
    }
    
    var serverResource = new Server("serverResource", ServerArgs.builder()
        .enabled(false)
        .pushDhcp(false)
        .serverIp("string")
        .serverMask("string")
        .serverPort(0)
        .build());
    
    server_resource = freebox.vpn.Server("serverResource",
        enabled=False,
        push_dhcp=False,
        server_ip="string",
        server_mask="string",
        server_port=0)
    
    const serverResource = new freebox.vpn.Server("serverResource", {
        enabled: false,
        pushDhcp: false,
        serverIp: "string",
        serverMask: "string",
        serverPort: 0,
    });
    
    type: freebox:vpn:Server
    properties:
        enabled: false
        pushDhcp: false
        serverIp: string
        serverMask: string
        serverPort: 0
    

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

    enabled Boolean
    pushDhcp Boolean
    serverIp String
    serverMask String
    serverPort Integer
    enabled boolean
    pushDhcp boolean
    serverIp string
    serverMask string
    serverPort number
    enabled Boolean
    pushDhcp Boolean
    serverIp String
    serverMask String
    serverPort Number

    Outputs

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

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

    Package Details

    Repository
    freebox
    License
    freebox logo
    Viewing docs for Freebox v0.3.11
    published on Friday, Jul 3, 2026 by OlivierPaquien

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial