Class SubnetsResource

Subnets management resource

Hierarchy

BaseResource
- SubnetsResource

Index

Constructors

constructor

new SubnetsResource(client: TenantosClient): SubnetsResource
Parameters
- client: TenantosClient
Returns SubnetsResource
Inherited from BaseResource.constructor
- Defined in resources.ts:85

Properties

`Protected` `Readonly`client

client: TenantosClient

Methods

childsMassActions

childsMassActions(subnetId: number, data: any): Promise<void>
Parameters
- subnetId: number
- data: any
Returns Promise<void>
- Defined in resources.ts:929

create

create(
    data: {
        access_vlan_generation_mode?: string;
        cidr: number;
        copy_network_automation_configuration_to_childs?: boolean;
        description?: string;
        dns_resolvers?: string[];
        dont_offer_if_server_has_tag?: string[];
        enable_switch_automation?: boolean;
        exclude_from_dynamic_ip_assignments?: boolean;
        generateIps?: boolean;
        gw: string;
        netmask: string;
        offer_if_server_has_tag?: string[];
        only_if_server_has_remote_agents?: number[];
        priority?: number;
        range_end_access_vlan_id?: number;
        range_start_access_vlan_id?: number;
        reserve_broadcast_ip?: boolean;
        reserve_first_usable_ip?: boolean;
        reserve_gateway_ip?: boolean;
        reserve_last_usable_ip?: boolean;
        reserve_network_address?: boolean;
        reuse_access_vlan?: boolean;
        static_access_vlan_id?: number;
        subnet: string;
        trunk_vlans?: number[];
        type: string;
        use_existing_port_access_vlan?: boolean;
        userId?: number;
        vlan_layer3_ip?: string;
        vlan_layer3_mode?: string;
        vlan_mode?: string;
        vlan_remove_layer3_ip_on_unassign?: boolean;
    },
): Promise<Subnet>
Parameters
- data: {
      access_vlan_generation_mode?: string;
      cidr: number;
      copy_network_automation_configuration_to_childs?: boolean;
      description?: string;
      dns_resolvers?: string[];
      dont_offer_if_server_has_tag?: string[];
      enable_switch_automation?: boolean;
      exclude_from_dynamic_ip_assignments?: boolean;
      generateIps?: boolean;
      gw: string;
      netmask: string;
      offer_if_server_has_tag?: string[];
      only_if_server_has_remote_agents?: number[];
      priority?: number;
      range_end_access_vlan_id?: number;
      range_start_access_vlan_id?: number;
      reserve_broadcast_ip?: boolean;
      reserve_first_usable_ip?: boolean;
      reserve_gateway_ip?: boolean;
      reserve_last_usable_ip?: boolean;
      reserve_network_address?: boolean;
      reuse_access_vlan?: boolean;
      static_access_vlan_id?: number;
      subnet: string;
      trunk_vlans?: number[];
      type: string;
      use_existing_port_access_vlan?: boolean;
      userId?: number;
      vlan_layer3_ip?: string;
      vlan_layer3_mode?: string;
      vlan_mode?: string;
      vlan_remove_layer3_ip_on_unassign?: boolean;
  }
  - Optionalaccess_vlan_generation_mode?: string
    Description
    Must be one of fixed or range.
    
    Example
    fixed
  - cidr: number
    Description
    The CIDR notation, optional if netmask is set.
    
    Example
    24
  - Optionalcopy_network_automation_configuration_to_childs?: boolean
    Example
    true
  - Optionaldescription?: string
    Description
    Subnet description.
    
    Example
    null
  - Optionaldns_resolvers?: string[]
    Description
    An unique array of IPv4 and/or IPv6 addresses. If not empty, a minimum of two is required and a maximum of three allowed. Defaults to Google DNS.
    
    Example
    [ "1.1.1.1", "1.0.0.1", "8.8.8.8" ]
  - Optionaldont_offer_if_server_has_tag?: string[]
    Example
    [ "fugit" ]
  - Optionalenable_switch_automation?: boolean
    Example
    false
  - Optionalexclude_from_dynamic_ip_assignments?: boolean
    Example
    false
  - OptionalgenerateIps?: boolean
    Example
    true
  - gw: string
    Description
    The gateway IP.
    
    Example
    10.10.11.1
  - netmask: string
    Description
    The netmask, optional if cidr is set.
    
    Example
    255.255.255.0
  - Optionaloffer_if_server_has_tag?: string[]
    Example
    [ "adipisci" ]
  - Optionalonly_if_server_has_remote_agents?: number[]
    Example
    [ 7 ]
  - Optionalpriority?: number
    Description
    Subnet priority. Used for virtual server provisioning.
    
    Example
    null
  - Optionalrange_end_access_vlan_id?: number
    Description
    Must not be greater than 4094.
    
    Example
    2884
  - Optionalrange_start_access_vlan_id?: number
    Description
    Must be at least 1.
    
    Example
    1
  - Optionalreserve_broadcast_ip?: boolean
    Description
    Defaults to true if not set.
    
    Example
    null
  - Optionalreserve_first_usable_ip?: boolean
    Description
    Defaults to false if not set.
    
    Example
    null
  - Optionalreserve_gateway_ip?: boolean
    Description
    Defaults to true if not set.
    
    Example
    null
  - Optionalreserve_last_usable_ip?: boolean
    Description
    Defaults to false if not set.
    
    Example
    null
  - Optionalreserve_network_address?: boolean
    Description
    Defaults to true if not set.
    
    Example
    null
  - Optionalreuse_access_vlan?: boolean
    Example
    false
  - Optionalstatic_access_vlan_id?: number
    Example
    8
  - subnet: string
    Description
    Must be a valid IP address (network address).
    
    Example
    10.10.11.0
  - Optionaltrunk_vlans?: number[]
    Description
    Must be at least 1. Must not be greater than 4094.
    
    Example
    [ 1441 ]
  - type: string
    Description
    Must be one of v4 or v6.
    
    Example
    v4
  - Optionaluse_existing_port_access_vlan?: boolean
    Example
    true
  - OptionaluserId?: number
    Example
    12
  - Optionalvlan_layer3_ip?: string
    Example
    est
  - Optionalvlan_layer3_mode?: string
    Description
    Must be one of none, gateway, or custom.
    
    Example
    custom
  - Optionalvlan_mode?: string
    Description
    Must be one of access or native+trunk.
    
    Example
    access
  - Optionalvlan_remove_layer3_ip_on_unassign?: boolean
    Example
    true
Returns Promise<Subnet>
- Defined in resources.ts:880

createRdnsAssignment

createRdnsAssignment(subnet: string, data: any): Promise<void>
Parameters
- subnet: string
- data: any
Returns Promise<void>
- Defined in resources.ts:962

delete

delete(id: number): Promise<void>
Parameters
- id: number
Returns Promise<void>
- Defined in resources.ts:910

deleteRdnsAssignment

deleteRdnsAssignment(subnet: string): Promise<void>
Parameters
- subnet: string
Returns Promise<void>
- Defined in resources.ts:970

get

get(id: number): Promise<Subnet>
Parameters
- id: number
Returns Promise<Subnet>
- Defined in resources.ts:850

getRdnsAssignment

getRdnsAssignment(subnetId: number): Promise<any>
Parameters
- subnetId: number
Returns Promise<any>
- Defined in resources.ts:951

getWithDetails

getWithDetails(subnetId: number): Promise<Subnet>
Parameters
- subnetId: number
Returns Promise<Subnet>
- Defined in resources.ts:865

list

list(options?: ListOptions<SubnetFilters>): Promise<Subnet[]>
Parameters
- options: ListOptions<SubnetFilters> = {}
Returns Promise<Subnet[]>
- Defined in resources.ts:838

listFreeIps

listFreeIps(subnetId: number): Promise<string[]>
Parameters
- subnetId: number
Returns Promise<string[]>
- Defined in resources.ts:939

`Protected`request

request<T>(config: RequestConfig): Promise<ApiResponse<T>>
Make a request to the API with automatic error handling
Type Parameters
- T
Parameters
- config: RequestConfig
Returns Promise<ApiResponse<T>>
Inherited from BaseResource.request
- Defined in resources.ts:90

split

split(subnetId: number, data: any): Promise<void>
Parameters
- subnetId: number
- data: any
Returns Promise<void>
- Defined in resources.ts:919

update

update(id: number, data: Partial<CreateSubnetRequest>): Promise<Subnet>
Parameters
- id: number
- data: Partial<CreateSubnetRequest>
Returns Promise<Subnet>
- Defined in resources.ts:894

`Protected`validateId

validateId(id: number, resourceName?: string): void
Validate that an ID is a positive integer
Parameters
- id: number
- resourceName: string = 'Resource'
Returns void
Inherited from BaseResource.validateId
- Defined in resources.ts:97

`Protected`validateRequiredString

validateRequiredString(value: string, fieldName: string): void
Validate required string field
Parameters
- value: string
- fieldName: string
Returns void
Inherited from BaseResource.validateRequiredString
- Defined in resources.ts:106

Class SubnetsResource

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns SubnetsResource

Properties

Protected Readonlyclient

Methods

childsMassActions

Parameters

Returns Promise<void>

create

Parameters

Optionalaccess_vlan_generation_mode?: string

Description

Example

cidr: number

Description

Example

Optionalcopy_network_automation_configuration_to_childs?: boolean

Example

Optionaldescription?: string

Description

Example

Optionaldns_resolvers?: string[]

Description

Example

Optionaldont_offer_if_server_has_tag?: string[]

Example

Optionalenable_switch_automation?: boolean

Example

Optionalexclude_from_dynamic_ip_assignments?: boolean

Example

OptionalgenerateIps?: boolean

Example

gw: string

Description

Example

netmask: string

Description

Example

Optionaloffer_if_server_has_tag?: string[]

Example

Optionalonly_if_server_has_remote_agents?: number[]

Example

Optionalpriority?: number

Description

Example

Optionalrange_end_access_vlan_id?: number

Description

Example

Optionalrange_start_access_vlan_id?: number

Description

Example

Optionalreserve_broadcast_ip?: boolean

Description

Example

Optionalreserve_first_usable_ip?: boolean

Description

Example

Optionalreserve_gateway_ip?: boolean

Description

Example

Optionalreserve_last_usable_ip?: boolean

Description

Example

Optionalreserve_network_address?: boolean

Description

Example

Optionalreuse_access_vlan?: boolean

Example

Optionalstatic_access_vlan_id?: number

Example

subnet: string

Description

`Protected` `Readonly`client

`Optional`access_vlan_generation_mode?: string

`Optional`copy_network_automation_configuration_to_childs?: boolean

`Optional`description?: string

`Optional`dns_resolvers?: string[]

`Optional`dont_offer_if_server_has_tag?: string[]

`Optional`enable_switch_automation?: boolean

`Optional`exclude_from_dynamic_ip_assignments?: boolean

`Optional`generateIps?: boolean

`Optional`offer_if_server_has_tag?: string[]

`Optional`only_if_server_has_remote_agents?: number[]

`Optional`priority?: number

`Optional`range_end_access_vlan_id?: number

`Optional`range_start_access_vlan_id?: number

`Optional`reserve_broadcast_ip?: boolean

`Optional`reserve_first_usable_ip?: boolean

`Optional`reserve_gateway_ip?: boolean

`Optional`reserve_last_usable_ip?: boolean

`Optional`reserve_network_address?: boolean

`Optional`reuse_access_vlan?: boolean

`Optional`static_access_vlan_id?: number

`Optional`trunk_vlans?: number[]

`Optional`use_existing_port_access_vlan?: boolean

`Optional`userId?: number

`Optional`vlan_layer3_ip?: string

`Optional`vlan_layer3_mode?: string

`Optional`vlan_mode?: string

`Optional`vlan_remove_layer3_ip_on_unassign?: boolean

`Protected`request

`Protected`validateId

`Protected`validateRequiredString