/** * The Subnet model module. * @module Ntnx/Subnet * @version 4.4.1 * @class Subnet * @extends NetworkingBaseModel */ export default class Subnet extends NetworkingBaseModel { /** * Returns Name of the subnet. * @return {string} */ getName(): string; /** * Sets Name of the subnet. * @param {string} name Name of the subnet. */ setName(name: string): void; name: string; /** * Returns Description of the subnet. * @return {string} */ getDescription(): string; /** * Sets Description of the subnet. * @param {string} description Description of the subnet. */ setDescription(description: string): void; description: string; /** * @return {SubnetType} */ getSubnetType(): SubnetType; /** * @param {SubnetType} subnetType */ setSubnetType(subnetType: SubnetType): void; subnetType: string; /** * Returns For VLAN subnet, this field represents VLAN Id, valid range is from 0 to 4095; For overlay subnet, this field represents 24-bit VNI, this field is read-only. * minimum: 0 * maximum: 16777215 * @return {Number} */ getNetworkId(): number; /** * Sets For VLAN subnet, this field represents VLAN Id, valid range is from 0 to 4095; For overlay subnet, this field represents 24-bit VNI, this field is read-only. * @param {Number} networkId For VLAN subnet, this field represents VLAN Id, valid range is from 0 to 4095; For overlay subnet, this field represents 24-bit VNI, this field is read-only. */ setNetworkId(networkId: number): void; networkId: number; /** * @return {DhcpOptions} */ getDhcpOptions(): DhcpOptions; /** * @param {DhcpOptions} dhcpOptions */ setDhcpOptions(dhcpOptions: DhcpOptions): void; dhcpOptions: DhcpOptions; /** * Returns IP configuration for the subnet. * @return {IPConfig[]} */ getIpConfig(): IPConfig[]; /** * Sets IP configuration for the subnet. * @param {IPConfig[]} ipConfig IP configuration for the subnet. */ setIpConfig(ipConfig: IPConfig[]): void; ipConfig: IPConfig[]; /** * Returns UUID of the cluster this subnet belongs to. * @return {string} */ getClusterReference(): string; /** * Sets UUID of the cluster this subnet belongs to. * @param {string} clusterReference UUID of the cluster this subnet belongs to. */ setClusterReference(clusterReference: string): void; clusterReference: string; /** * Returns List of UUIDs of the cluster this subnet belongs to. * @return {string[]} */ getClusterReferenceList(): string[]; /** * Sets List of UUIDs of the cluster this subnet belongs to. * @param {string[]} clusterReferenceList List of UUIDs of the cluster this subnet belongs to. */ setClusterReferenceList(clusterReferenceList: string[]): void; clusterReferenceList: string[]; /** * Returns List of cluster names this subnet belongs to. * @return {string[]} */ getClusterNameList(): string[]; /** * Sets List of cluster names this subnet belongs to. * @param {string[]} clusterNameList List of cluster names this subnet belongs to. */ setClusterNameList(clusterNameList: string[]): void; clusterNameList: string[]; /** * Returns UUID of the virtual switch this subnet belongs to (type VLAN only). * @return {string} */ getVirtualSwitchReference(): string; /** * Sets UUID of the virtual switch this subnet belongs to (type VLAN only). * @param {string} virtualSwitchReference UUID of the virtual switch this subnet belongs to (type VLAN only). */ setVirtualSwitchReference(virtualSwitchReference: string): void; virtualSwitchReference: string; /** * Returns UUID of Virtual Private Cloud this subnet belongs to (type Overlay only). * @return {string} */ getVpcReference(): string; /** * Sets UUID of Virtual Private Cloud this subnet belongs to (type Overlay only). * @param {string} vpcReference UUID of Virtual Private Cloud this subnet belongs to (type Overlay only). */ setVpcReference(vpcReference: string): void; vpcReference: string; /** * Returns Indicates whether NAT must be enabled for VPCs attached to the subnet. This is supported only for external subnets. NAT is enabled by default on external subnets. * @return {boolean} */ getIsNatEnabled(): boolean; /** * Sets Indicates whether NAT must be enabled for VPCs attached to the subnet. This is supported only for external subnets. NAT is enabled by default on external subnets. * @param {boolean} isNatEnabled Indicates whether NAT must be enabled for VPCs attached to the subnet. This is supported only for external subnets. NAT is enabled by default on external subnets. */ setIsNatEnabled(isNatEnabled: boolean): void; isNatEnabled: boolean; /** * Returns Indicates whether the subnet is used for external connectivity. * @return {boolean} */ getIsExternal(): boolean; /** * Sets Indicates whether the subnet is used for external connectivity. * @param {boolean} isExternal Indicates whether the subnet is used for external connectivity. */ setIsExternal(isExternal: boolean): void; isExternal: boolean; /** * Returns List of IPs that are excluded while allocating IP addresses to VM ports. * @return {IPAddress[]} */ getReservedIpAddresses(): IPAddress[]; /** * Sets List of IPs that are excluded while allocating IP addresses to VM ports. * @param {IPAddress[]} reservedIpAddresses List of IPs that are excluded while allocating IP addresses to VM ports. */ setReservedIpAddresses(reservedIpAddresses: IPAddress[]): void; reservedIpAddresses: IPAddress[]; /** * Returns List of IPs, which are a subset from the reserved IP address list, that must be advertised to the SDN gateway. * @return {IPAddress[]} */ getDynamicIpAddresses(): IPAddress[]; /** * Sets List of IPs, which are a subset from the reserved IP address list, that must be advertised to the SDN gateway. * @param {IPAddress[]} dynamicIpAddresses List of IPs, which are a subset from the reserved IP address list, that must be advertised to the SDN gateway. */ setDynamicIpAddresses(dynamicIpAddresses: IPAddress[]): void; dynamicIpAddresses: IPAddress[]; /** * Returns UUID of the Network function chain entity that this subnet belongs to (type VLAN only). * @return {string} */ getNetworkFunctionChainReference(): string; /** * Sets UUID of the Network function chain entity that this subnet belongs to (type VLAN only). * @param {string} networkFunctionChainReference UUID of the Network function chain entity that this subnet belongs to (type VLAN only). */ setNetworkFunctionChainReference(networkFunctionChainReference: string): void; networkFunctionChainReference: string; /** * Returns Name of the bridge on the host for the subnet. * @return {string} */ getBridgeName(): string; /** * Sets Name of the bridge on the host for the subnet. * @param {string} bridgeName Name of the bridge on the host for the subnet. */ setBridgeName(bridgeName: string): void; bridgeName: string; /** * Returns Indicates whether the subnet is used for advanced networking. * @return {boolean} */ getIsAdvancedNetworking(): boolean; /** * Sets Indicates whether the subnet is used for advanced networking. * @param {boolean} isAdvancedNetworking Indicates whether the subnet is used for advanced networking. */ setIsAdvancedNetworking(isAdvancedNetworking: boolean): void; isAdvancedNetworking: boolean; /** * Returns Cluster Name * @return {string} */ getClusterName(): string; /** * Sets Cluster Name * @param {string} clusterName Cluster Name */ setClusterName(clusterName: string): void; clusterName: string; /** * Returns Hypervisor Type * @return {string} */ getHypervisorType(): string; /** * Sets Hypervisor Type * @param {string} hypervisorType Hypervisor Type */ setHypervisorType(hypervisorType: string): void; hypervisorType: string; /** * @return {VirtualSwitch} */ getVirtualSwitch(): VirtualSwitch; /** * @param {VirtualSwitch} virtualSwitch */ setVirtualSwitch(virtualSwitch: VirtualSwitch): void; virtualSwitch: VirtualSwitch; /** * @return {Vpc} */ getVpc(): Vpc; /** * @param {Vpc} vpc */ setVpc(vpc: Vpc): void; vpc: Vpc; /** * @return {Layer2Stretch} */ getLayer2StretchReference(): Layer2Stretch; /** * @param {Layer2Stretch} layer2StretchReference */ setLayer2StretchReference(layer2StretchReference: Layer2Stretch): void; layer2StretchReference: Layer2Stretch; /** * Returns IP Prefix in CIDR format. * @return {string} */ getIpPrefix(): string; /** * Sets IP Prefix in CIDR format. * @param {string} ipPrefix IP Prefix in CIDR format. */ setIpPrefix(ipPrefix: string): void; ipPrefix: string; /** * @return {IPUsage} */ getIpUsage(): IPUsage; /** * @param {IPUsage} ipUsage */ setIpUsage(ipUsage: IPUsage): void; ipUsage: IPUsage; /** * @return {MigrationState} */ getMigrationState(): MigrationState; /** * @param {MigrationState} migrationState */ setMigrationState(migrationState: MigrationState): void; migrationState: string; /** * Returns List of External DHCP servers used by this subnet. * @return {ExternalDhcpServer[]} */ getExternalDhcpServers(): ExternalDhcpServer[]; /** * Sets List of External DHCP servers used by this subnet. * @param {ExternalDhcpServer[]} externalDhcpServers List of External DHCP servers used by this subnet. */ setExternalDhcpServers(externalDhcpServers: ExternalDhcpServer[]): void; externalDhcpServers: ExternalDhcpServer[]; /** * Returns Indicates whether the subnet is in a connected or disconnected state. * @return {boolean} */ getIsConnected(): boolean; /** * Sets Indicates whether the subnet is in a connected or disconnected state. * @param {boolean} isConnected Indicates whether the subnet is in a connected or disconnected state. */ setIsConnected(isConnected: boolean): void; isConnected: boolean; /** * Returns List of project UUIDs this subnet is shared with. * @return {string[]} */ getSharedWithProjects(): string[]; /** * Sets List of project UUIDs this subnet is shared with. * @param {string[]} sharedWithProjects List of project UUIDs this subnet is shared with. */ setSharedWithProjects(sharedWithProjects: string[]): void; sharedWithProjects: string[]; #private; } import NetworkingBaseModel from "./NetworkingBaseModel"; import SubnetType from "./SubnetType"; import DhcpOptions from "./DhcpOptions"; import IPConfig from "./IPConfig"; import IPAddress from "../../../common/v1/config/IPAddress"; import VirtualSwitch from "./VirtualSwitch"; import Vpc from "./Vpc"; import Layer2Stretch from "./Layer2Stretch"; import IPUsage from "./IPUsage"; import MigrationState from "./MigrationState"; import ExternalDhcpServer from "./ExternalDhcpServer";